You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GlobalAccelerator::Types::CreateAcceleratorRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAcceleratorRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "GenericString", # required
  ip_address_type: "IPV4", # accepts IPV4
  ip_addresses: ["IpAddress"],
  enabled: false,
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

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

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

Returns:

  • (Boolean) —

    Indicates whether an accelerator is enabled.

#idempotency_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

Returns:

  • (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

#ip_address_type ⇒ String

The value for the address type must be IPv4.

Possible values:

  • IPV4

Returns:

  • (String) —

    The value for the address type must be IPv4.

#ip_addresses ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    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.

#name ⇒ String

The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

Returns:

  • (String) —

    The name of an accelerator.

#tags ⇒ Array<Types::Tag>

Create tags for an accelerator.

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

Returns:

  • (Array<Types::Tag>) —

    Create tags for an accelerator.