Package 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:
IEnvironmentAware, IInspectable, ITaggable, IAcceleratorRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:42.417Z") @Stability(Stable) public class CfnAccelerator extends CfnResource implements IInspectable, IAcceleratorRef, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccelerator

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

    • CfnAccelerator

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

    • CfnAccelerator

      @Stability(Stable) public CfnAccelerator(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAcceleratorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAcceleratorRef

      @Stability(Stable) @NotNull public AcceleratorReference getAcceleratorRef()
      A reference to a Accelerator resource.
      Specified by:
      getAcceleratorRef in interface IAcceleratorRef

    • getAttrAcceleratorArn

      @Stability(Stable) @NotNull public String getAttrAcceleratorArn()
      The ARN of the accelerator, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh .

    • getAttrDnsName

      @Stability(Stable) @NotNull public String getAttrDnsName()
      The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.

    • getAttrDualStackDnsName

      @Stability(Stable) @NotNull public String getAttrDualStackDnsName()
      The DNS name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

    • getAttrIpv4Addresses

      @Stability(Stable) @NotNull public List<String> getAttrIpv4Addresses()
      The array of IPv4 addresses in the IP address set.

      An IP address set can have a maximum of two IP addresses.

    • getAttrIpv6Addresses

      @Stability(Stable) @NotNull public List<String> getAttrIpv6Addresses()
      The array of IPv6 addresses in the IP address set.

      An IP address set can have a maximum of two IP addresses.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the accelerator.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the accelerator.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      Indicates whether the accelerator is enabled.

      The value is true or false. The default value is true.

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Indicates whether the accelerator is enabled.

      The value is true or false. The default value is true.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Indicates whether the accelerator is enabled.

      The value is true or false. The default value is true.

    • getIpAddresses

      @Stability(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.

    • setIpAddresses

      @Stability(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.

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      The IP address type that an accelerator supports.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      The IP address type that an accelerator supports.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Create tags for an accelerator.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Create tags for an accelerator.