AWS::GlobalAccelerator::Accelerator - AWS 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::GlobalAccelerator::Accelerator", "Properties" : { "Enabled" : Boolean, "IpAddresses" : [ String, ... ], "IpAddressType" : String, "Name" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::GlobalAccelerator::Accelerator Properties: Enabled: Boolean IpAddresses: - String IpAddressType: String Name: String Tags: - Tag

Properties

Enabled

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.

Required: No

Type: Boolean

Update requires: No interruption

IpAddresses

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.

Required: No

Type: List of String

Update requires: No interruption

IpAddressType

The value for the address type must be IPv4.

Required: No

Type: String

Allowed values: IPV4

Update requires: No interruption

Name

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

Required: Yes

Type: String

Maximum: 255

Update requires: No interruption

Tags

Create tags for an accelerator.

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

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the accelerator, such as arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AcceleratorArn

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

DnsName

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

Examples

Add an accelerator

These are examples to specify an accelerator.

JSON

"Resources": { "Accelerator": { "Type": "AWS::GlobalAccelerator::Accelerator", "Properties": { "Name": "SampleAccelerator", "Enabled": true } }, "Outputs": { "AcceleratorDnsName": { "Description": "Accelerator DNS Name", "Value": { "Fn::GetAtt": [ "Accelerator", "DnsName" ] } } } }

YAML

Accelerator: Type: AWS::GlobalAccelerator::Accelerator Properties: Name: SampleAccelerator Enabled: true Outputs: AcceleratorDnsName: Description: Accelerator DNS Name Value: Fn::GetAtt: - Accelerator - DnsName