This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::GlobalAccelerator::EndpointGroup
<a name="aws-resource-globalaccelerator-endpointgroup"></a>

The `AWS::GlobalAccelerator::EndpointGroup` resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region.

## Syntax
<a name="aws-resource-globalaccelerator-endpointgroup-syntax"></a>

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

### JSON
<a name="aws-resource-globalaccelerator-endpointgroup-syntax.json"></a>

```
{
  "Type" : "AWS::GlobalAccelerator::EndpointGroup",
  "Properties" : {
      "[EndpointConfigurations](#cfn-globalaccelerator-endpointgroup-endpointconfigurations)" : [ EndpointConfiguration, ... ],
      "[EndpointGroupRegion](#cfn-globalaccelerator-endpointgroup-endpointgroupregion)" : String,
      "[HealthCheckIntervalSeconds](#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds)" : Integer,
      "[HealthCheckPath](#cfn-globalaccelerator-endpointgroup-healthcheckpath)" : String,
      "[HealthCheckPort](#cfn-globalaccelerator-endpointgroup-healthcheckport)" : Integer,
      "[HealthCheckProtocol](#cfn-globalaccelerator-endpointgroup-healthcheckprotocol)" : String,
      "[ListenerArn](#cfn-globalaccelerator-endpointgroup-listenerarn)" : String,
      "[PortOverrides](#cfn-globalaccelerator-endpointgroup-portoverrides)" : [ PortOverride, ... ],
      "[ThresholdCount](#cfn-globalaccelerator-endpointgroup-thresholdcount)" : Integer,
      "[TrafficDialPercentage](#cfn-globalaccelerator-endpointgroup-trafficdialpercentage)" : Number
    }
}
```

### YAML
<a name="aws-resource-globalaccelerator-endpointgroup-syntax.yaml"></a>

```
Type: AWS::GlobalAccelerator::EndpointGroup
Properties:
  [EndpointConfigurations](#cfn-globalaccelerator-endpointgroup-endpointconfigurations): 
    - EndpointConfiguration
  [EndpointGroupRegion](#cfn-globalaccelerator-endpointgroup-endpointgroupregion): String
  [HealthCheckIntervalSeconds](#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds): Integer
  [HealthCheckPath](#cfn-globalaccelerator-endpointgroup-healthcheckpath): String
  [HealthCheckPort](#cfn-globalaccelerator-endpointgroup-healthcheckport): Integer
  [HealthCheckProtocol](#cfn-globalaccelerator-endpointgroup-healthcheckprotocol): String
  [ListenerArn](#cfn-globalaccelerator-endpointgroup-listenerarn): String
  [PortOverrides](#cfn-globalaccelerator-endpointgroup-portoverrides): 
    - PortOverride
  [ThresholdCount](#cfn-globalaccelerator-endpointgroup-thresholdcount): Integer
  [TrafficDialPercentage](#cfn-globalaccelerator-endpointgroup-trafficdialpercentage): Number
```

## Properties
<a name="aws-resource-globalaccelerator-endpointgroup-properties"></a>

`EndpointConfigurations`  <a name="cfn-globalaccelerator-endpointgroup-endpointconfigurations"></a>
The list of endpoint objects.  
*Required*: No  
*Type*: Array of [EndpointConfiguration](aws-properties-globalaccelerator-endpointgroup-endpointconfiguration.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndpointGroupRegion`  <a name="cfn-globalaccelerator-endpointgroup-endpointgroupregion"></a>
The AWS Regions where the endpoint group is located.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`HealthCheckIntervalSeconds`  <a name="cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds"></a>
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.  
*Required*: No  
*Type*: Integer  
*Minimum*: `10`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HealthCheckPath`  <a name="cfn-globalaccelerator-endpointgroup-healthcheckpath"></a>
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).  
*Required*: No  
*Type*: String  
*Pattern*: `^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HealthCheckPort`  <a name="cfn-globalaccelerator-endpointgroup-healthcheckport"></a>
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.   
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.  
*Required*: No  
*Type*: Integer  
*Minimum*: `-1`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HealthCheckProtocol`  <a name="cfn-globalaccelerator-endpointgroup-healthcheckprotocol"></a>
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.  
*Required*: No  
*Type*: String  
*Allowed values*: `TCP | HTTP | HTTPS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ListenerArn`  <a name="cfn-globalaccelerator-endpointgroup-listenerarn"></a>
The Amazon Resource Name (ARN) of the listener.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PortOverrides`  <a name="cfn-globalaccelerator-endpointgroup-portoverrides"></a>
Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.   
*Required*: No  
*Type*: Array of [PortOverride](aws-properties-globalaccelerator-endpointgroup-portoverride.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThresholdCount`  <a name="cfn-globalaccelerator-endpointgroup-thresholdcount"></a>
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrafficDialPercentage`  <a name="cfn-globalaccelerator-endpointgroup-trafficdialpercentage"></a>
The percentage of traffic to send to an AWS Regions. Additional traffic is distributed to other endpoint groups for this listener.   
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.  
The default value is 100.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-globalaccelerator-endpointgroup-return-values"></a>

### Ref
<a name="aws-resource-globalaccelerator-endpointgroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the endpoint group, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-globalaccelerator-endpointgroup-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-globalaccelerator-endpointgroup-return-values-fn--getatt-fn--getatt"></a>

`EndpointGroupArn`  <a name="EndpointGroupArn-fn::getatt"></a>
The ARN of the endpoint group, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu`.

## Examples
<a name="aws-resource-globalaccelerator-endpointgroup--examples"></a>



### Add an endpoint group
<a name="aws-resource-globalaccelerator-endpointgroup--examples--Add_an_endpoint_group"></a>

These are examples to specify an endpoint group.

#### JSON
<a name="aws-resource-globalaccelerator-endpointgroup--examples--Add_an_endpoint_group--json"></a>

```
"Resources": {
        "EndpointGroup": {
        "Type": "AWS::GlobalAccelerator::EndpointGroup",
        "Properties": {
            "ListenerArn": {
                "Ref": "Listener"
            },
            "EndpointGroupRegion": {
                "Ref": "EndpointRegion"
            },
            "TrafficDialPercentage": 100.0,
            "EndpointConfigurations": [
                {
                    "EndpointId": {
                        "Ref": "EndpointId"
                    }
                }
            ]
        }
    }
}
```

#### YAML
<a name="aws-resource-globalaccelerator-endpointgroup--examples--Add_an_endpoint_group--yaml"></a>

```
EndpointGroup:
  Type: AWS::GlobalAccelerator::EndpointGroup
  Properties:
    ListenerArn:
      Ref: Listener
    EndpointGroupRegion:
      Ref: EndpointRegion
    TrafficDialPercentage: 100
    EndpointConfigurations:
    - EndpointId:
        Ref: EndpointId
```

# AWS::GlobalAccelerator::EndpointGroup EndpointConfiguration
<a name="aws-properties-globalaccelerator-endpointgroup-endpointconfiguration"></a>

A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

## Syntax
<a name="aws-properties-globalaccelerator-endpointgroup-endpointconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-globalaccelerator-endpointgroup-endpointconfiguration-syntax.json"></a>

```
{
  "[AttachmentArn](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-attachmentarn)" : String,
  "[ClientIPPreservationEnabled](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-clientippreservationenabled)" : Boolean,
  "[EndpointId](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-endpointid)" : String,
  "[Weight](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-weight)" : Integer
}
```

### YAML
<a name="aws-properties-globalaccelerator-endpointgroup-endpointconfiguration-syntax.yaml"></a>

```
  [AttachmentArn](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-attachmentarn): String
  [ClientIPPreservationEnabled](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-clientippreservationenabled): Boolean
  [EndpointId](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-endpointid): String
  [Weight](#cfn-globalaccelerator-endpointgroup-endpointconfiguration-weight): Integer
```

## Properties
<a name="aws-properties-globalaccelerator-endpointgroup-endpointconfiguration-properties"></a>

`AttachmentArn`  <a name="cfn-globalaccelerator-endpointgroup-endpointconfiguration-attachmentarn"></a>
The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.  
*Required*: No  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientIPPreservationEnabled`  <a name="cfn-globalaccelerator-endpointgroup-endpointconfiguration-clientippreservationenabled"></a>
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.   
If the value is set to true, the client's IP address is preserved in the `X-Forwarded-For` request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.  
For more information, see [ Preserve Client IP Addresses](https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) in the *AWS Global Accelerator Developer Guide*.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndpointId`  <a name="cfn-globalaccelerator-endpointgroup-endpointconfiguration-endpointid"></a>
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.  
For cross-account endpoints, this must be the ARN of the resource.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-globalaccelerator-endpointgroup-endpointconfiguration-weight"></a>
The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see [Endpoint Weights](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) in the *AWS Global Accelerator Developer Guide*.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::GlobalAccelerator::EndpointGroup PortOverride
<a name="aws-properties-globalaccelerator-endpointgroup-portoverride"></a>

Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see [ Port overrides](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) in the *AWS Global Accelerator Developer Guide*.

## Syntax
<a name="aws-properties-globalaccelerator-endpointgroup-portoverride-syntax"></a>

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

### JSON
<a name="aws-properties-globalaccelerator-endpointgroup-portoverride-syntax.json"></a>

```
{
  "[EndpointPort](#cfn-globalaccelerator-endpointgroup-portoverride-endpointport)" : Integer,
  "[ListenerPort](#cfn-globalaccelerator-endpointgroup-portoverride-listenerport)" : Integer
}
```

### YAML
<a name="aws-properties-globalaccelerator-endpointgroup-portoverride-syntax.yaml"></a>

```
  [EndpointPort](#cfn-globalaccelerator-endpointgroup-portoverride-endpointport): Integer
  [ListenerPort](#cfn-globalaccelerator-endpointgroup-portoverride-listenerport): Integer
```

## Properties
<a name="aws-properties-globalaccelerator-endpointgroup-portoverride-properties"></a>

`EndpointPort`  <a name="cfn-globalaccelerator-endpointgroup-portoverride-endpointport"></a>
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ListenerPort`  <a name="cfn-globalaccelerator-endpointgroup-portoverride-listenerport"></a>
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)