Package software.amazon.awscdk.services.globalaccelerator

Class CfnAccelerator

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.globalaccelerator.CfnAccelerator
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.496Z") @Stability(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();

  • 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 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 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.

    • 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()
      Create tags for an accelerator.

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

    • getName

      @Stability(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(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(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(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(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(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(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(Stable) @Nullable public String getIpAddressType()
      The IP address type that an accelerator supports.

      For a standard accelerator, the value can be IPV4 or DUAL_STACK.

    • setIpAddressType

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

      For a standard accelerator, the value can be IPV4 or DUAL_STACK.