Class Accelerator.Builder

java.lang.Object
software.amazon.awscdk.services.globalaccelerator.Accelerator.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Accelerator>
Enclosing class:
Accelerator

@Stability(Stable) public static final class Accelerator.Builder extends Object implements software.amazon.jsii.Builder<Accelerator>
A fluent builder for Accelerator.
  • Method Details

    • create

      @Stability(Stable) public static Accelerator.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Accelerator.Builder.
    • acceleratorName

      @Stability(Stable) public Accelerator.Builder acceleratorName(String acceleratorName)
      The name of the accelerator.

      Default: - resource ID

      Parameters:
      acceleratorName - The name of the accelerator. This parameter is required.
      Returns:
      this
    • enabled

      @Stability(Stable) public Accelerator.Builder enabled(Boolean enabled)
      Indicates whether the accelerator is enabled.

      Default: true

      Parameters:
      enabled - Indicates whether the accelerator is enabled. This parameter is required.
      Returns:
      this
    • ipAddresses

      @Stability(Stable) public Accelerator.Builder ipAddresses(List<String> ipAddresses)
      IP addresses associated with the accelerator.

      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.

      Default: - undefined. IP addresses will be from Amazon's pool of IP addresses.

      Parameters:
      ipAddresses - IP addresses associated with the accelerator. This parameter is required.
      Returns:
      this
    • ipAddressType

      @Stability(Stable) public Accelerator.Builder ipAddressType(IpAddressType ipAddressType)
      The IP address type that an accelerator supports.

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

      Default: - "IPV4"

      Parameters:
      ipAddressType - The IP address type that an accelerator supports. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public Accelerator build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Accelerator>
      Returns:
      a newly built instance of Accelerator.