software.amazon.awscdk.services.globalaccelerator

Class CfnAccelerator

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.globalaccelerator.CfnAccelerator

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.499Z")
 @Stability(value=Stable)
public class CfnAccelerator
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GlobalAccelerator::Accelerator`.

The AWS::GlobalAccelerator::Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.globalaccelerator.*;
 CfnAccelerator cfnAccelerator = CfnAccelerator.Builder.create(this, "MyCfnAccelerator")
         .name("name")
         // the properties below are optional
         .enabled(false)
         .ipAddresses(List.of("ipAddresses"))
         .ipAddressType("ipAddressType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAccelerator.Builder A fluent builder for CfnAccelerator.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccelerator(software.constructs.Construct scope, String id, CfnAcceleratorProps props) Create a new `AWS::GlobalAccelerator::Accelerator`.
protected	CfnAccelerator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccelerator(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAcceleratorArn() The ARN of the accelerator, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh` .
String	getAttrDnsName() The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
String	getAttrDualStackDnsName()
List<String>	getAttrIpv4Addresses()
List<String>	getAttrIpv6Addresses()
protected Map<String,Object>	getCfnProperties()
Object	getEnabled() Indicates whether the accelerator is enabled.
List<String>	getIpAddresses() Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.
String	getIpAddressType() The value for the address type must be IPv4.
String	getName() The name of the accelerator.
TagManager	getTags() Create tags for an accelerator.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEnabled(Boolean value) Indicates whether the accelerator is enabled.
void	setEnabled(IResolvable value) Indicates whether the accelerator is enabled.
void	setIpAddresses(List<String> value) Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.
void	setIpAddressType(String value) The value for the address type must be IPv4.
void	setName(String value) The name of the accelerator.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccelerator

protected CfnAccelerator(software.amazon.jsii.JsiiObjectRef objRef)

CfnAccelerator

protected CfnAccelerator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAccelerator

@Stability(value=Stable)
public CfnAccelerator(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnAcceleratorProps props)

Create a new `AWS::GlobalAccelerator::Accelerator`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAcceleratorArn

@Stability(value=Stable)
 @NotNull
public String getAttrAcceleratorArn()

The ARN of the accelerator, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh` .

getAttrDnsName

@Stability(value=Stable)
 @NotNull
public String getAttrDnsName()

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

getAttrDualStackDnsName

@Stability(value=Stable)
 @NotNull
public String getAttrDualStackDnsName()

getAttrIpv4Addresses

@Stability(value=Stable)
 @NotNull
public List<String> getAttrIpv4Addresses()

getAttrIpv6Addresses

@Stability(value=Stable)
 @NotNull
public List<String> getAttrIpv6Addresses()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Create tags for an accelerator.

For more information, see Tagging in the AWS Global Accelerator Developer Guide .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the accelerator.

The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the accelerator.

The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

getIpAddresses

@Stability(value=Stable)
 @Nullable
public List<String> getIpAddresses()

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.

You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

setIpAddresses

@Stability(value=Stable)
public void setIpAddresses(@Nullable
                                                    List<String> value)

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator.

You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

getIpAddressType

@Stability(value=Stable)
 @Nullable
public String getIpAddressType()

The value for the address type must be IPv4.

setIpAddressType

@Stability(value=Stable)
public void setIpAddressType(@Nullable
                                                      String value)

The value for the address type must be IPv4.