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::Redshift::EndpointAccess
<a name="aws-resource-redshift-endpointaccess"></a>

Creates a Redshift-managed VPC endpoint.

## Syntax
<a name="aws-resource-redshift-endpointaccess-syntax"></a>

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

### JSON
<a name="aws-resource-redshift-endpointaccess-syntax.json"></a>

```
{
  "Type" : "AWS::Redshift::EndpointAccess",
  "Properties" : {
      "[ClusterIdentifier](#cfn-redshift-endpointaccess-clusteridentifier)" : String,
      "[EndpointName](#cfn-redshift-endpointaccess-endpointname)" : String,
      "[ResourceOwner](#cfn-redshift-endpointaccess-resourceowner)" : String,
      "[SubnetGroupName](#cfn-redshift-endpointaccess-subnetgroupname)" : String,
      "[VpcSecurityGroupIds](#cfn-redshift-endpointaccess-vpcsecuritygroupids)" : [ String, ... ]
    }
}
```

### YAML
<a name="aws-resource-redshift-endpointaccess-syntax.yaml"></a>

```
Type: AWS::Redshift::EndpointAccess
Properties:
  [ClusterIdentifier](#cfn-redshift-endpointaccess-clusteridentifier): String
  [EndpointName](#cfn-redshift-endpointaccess-endpointname): String
  [ResourceOwner](#cfn-redshift-endpointaccess-resourceowner): String
  [SubnetGroupName](#cfn-redshift-endpointaccess-subnetgroupname): String
  [VpcSecurityGroupIds](#cfn-redshift-endpointaccess-vpcsecuritygroupids): 
    - String
```

## Properties
<a name="aws-resource-redshift-endpointaccess-properties"></a>

`ClusterIdentifier`  <a name="cfn-redshift-endpointaccess-clusteridentifier"></a>
The cluster identifier of the cluster associated with the endpoint.  
*Required*: Yes  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EndpointName`  <a name="cfn-redshift-endpointaccess-endpointname"></a>
The name of the endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ResourceOwner`  <a name="cfn-redshift-endpointaccess-resourceowner"></a>
The AWS account ID of the owner of the cluster.  
*Required*: No  
*Type*: String  
*Pattern*: `^\d{12}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetGroupName`  <a name="cfn-redshift-endpointaccess-subnetgroupname"></a>
The subnet group name where Amazon Redshift chooses to deploy the endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?=^[a-zA-Z0-9-]+$).{1,255}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcSecurityGroupIds`  <a name="cfn-redshift-endpointaccess-vpcsecuritygroupids"></a>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.  
*Required*: Yes  
*Type*: Array of String  
*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-redshift-endpointaccess-return-values"></a>

### Ref
<a name="aws-resource-redshift-endpointaccess-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

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-redshift-endpointaccess-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-redshift-endpointaccess-return-values-fn--getatt-fn--getatt"></a>

`Address`  <a name="Address-fn::getatt"></a>
The DNS address of the endpoint.

`EndpointCreateTime`  <a name="EndpointCreateTime-fn::getatt"></a>
The time (UTC) that the endpoint was created.

`EndpointStatus`  <a name="EndpointStatus-fn::getatt"></a>
The status of the endpoint.

`Port`  <a name="Port-fn::getatt"></a>
The port number on which the cluster accepts incoming connections.

`VpcEndpoint.VpcEndpointId`  <a name="VpcEndpoint.VpcEndpointId-fn::getatt"></a>
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

`VpcEndpoint.VpcId`  <a name="VpcEndpoint.VpcId-fn::getatt"></a>
The VPC identifier that the endpoint is associated.

`VpcSecurityGroups`  <a name="VpcSecurityGroups-fn::getatt"></a>
The security groups associated with the endpoint.

# AWS::Redshift::EndpointAccess NetworkInterface
<a name="aws-properties-redshift-endpointaccess-networkinterface"></a>

Describes a network interface. 

## Syntax
<a name="aws-properties-redshift-endpointaccess-networkinterface-syntax"></a>

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

### JSON
<a name="aws-properties-redshift-endpointaccess-networkinterface-syntax.json"></a>

```
{
  "[AvailabilityZone](#cfn-redshift-endpointaccess-networkinterface-availabilityzone)" : String,
  "[NetworkInterfaceId](#cfn-redshift-endpointaccess-networkinterface-networkinterfaceid)" : String,
  "[PrivateIpAddress](#cfn-redshift-endpointaccess-networkinterface-privateipaddress)" : String,
  "[SubnetId](#cfn-redshift-endpointaccess-networkinterface-subnetid)" : String
}
```

### YAML
<a name="aws-properties-redshift-endpointaccess-networkinterface-syntax.yaml"></a>

```
  [AvailabilityZone](#cfn-redshift-endpointaccess-networkinterface-availabilityzone): String
  [NetworkInterfaceId](#cfn-redshift-endpointaccess-networkinterface-networkinterfaceid): String
  [PrivateIpAddress](#cfn-redshift-endpointaccess-networkinterface-privateipaddress): String
  [SubnetId](#cfn-redshift-endpointaccess-networkinterface-subnetid): String
```

## Properties
<a name="aws-properties-redshift-endpointaccess-networkinterface-properties"></a>

`AvailabilityZone`  <a name="cfn-redshift-endpointaccess-networkinterface-availabilityzone"></a>
The Availability Zone.   
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkInterfaceId`  <a name="cfn-redshift-endpointaccess-networkinterface-networkinterfaceid"></a>
The network interface identifier.   
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrivateIpAddress`  <a name="cfn-redshift-endpointaccess-networkinterface-privateipaddress"></a>
The IPv4 address of the network interface within the subnet.   
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetId`  <a name="cfn-redshift-endpointaccess-networkinterface-subnetid"></a>
The subnet identifier.   
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Redshift::EndpointAccess VpcEndpoint
<a name="aws-properties-redshift-endpointaccess-vpcendpoint"></a>

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

## Syntax
<a name="aws-properties-redshift-endpointaccess-vpcendpoint-syntax"></a>

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

### JSON
<a name="aws-properties-redshift-endpointaccess-vpcendpoint-syntax.json"></a>

```
{
  "[NetworkInterfaces](#cfn-redshift-endpointaccess-vpcendpoint-networkinterfaces)" : [ NetworkInterface, ... ],
  "[VpcEndpointId](#cfn-redshift-endpointaccess-vpcendpoint-vpcendpointid)" : String,
  "[VpcId](#cfn-redshift-endpointaccess-vpcendpoint-vpcid)" : String
}
```

### YAML
<a name="aws-properties-redshift-endpointaccess-vpcendpoint-syntax.yaml"></a>

```
  [NetworkInterfaces](#cfn-redshift-endpointaccess-vpcendpoint-networkinterfaces): 
    - NetworkInterface
  [VpcEndpointId](#cfn-redshift-endpointaccess-vpcendpoint-vpcendpointid): String
  [VpcId](#cfn-redshift-endpointaccess-vpcendpoint-vpcid): String
```

## Properties
<a name="aws-properties-redshift-endpointaccess-vpcendpoint-properties"></a>

`NetworkInterfaces`  <a name="cfn-redshift-endpointaccess-vpcendpoint-networkinterfaces"></a>
One or more network interfaces of the endpoint. Also known as an interface endpoint.   
*Required*: No  
*Type*: Array of [NetworkInterface](aws-properties-redshift-endpointaccess-networkinterface.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcEndpointId`  <a name="cfn-redshift-endpointaccess-vpcendpoint-vpcendpointid"></a>
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.  
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-redshift-endpointaccess-vpcendpoint-vpcid"></a>
The VPC identifier that the endpoint is associated.   
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Redshift::EndpointAccess VpcSecurityGroup
<a name="aws-properties-redshift-endpointaccess-vpcsecuritygroup"></a>

The security groups associated with the endpoint.

## Syntax
<a name="aws-properties-redshift-endpointaccess-vpcsecuritygroup-syntax"></a>

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

### JSON
<a name="aws-properties-redshift-endpointaccess-vpcsecuritygroup-syntax.json"></a>

```
{
  "[Status](#cfn-redshift-endpointaccess-vpcsecuritygroup-status)" : String,
  "[VpcSecurityGroupId](#cfn-redshift-endpointaccess-vpcsecuritygroup-vpcsecuritygroupid)" : String
}
```

### YAML
<a name="aws-properties-redshift-endpointaccess-vpcsecuritygroup-syntax.yaml"></a>

```
  [Status](#cfn-redshift-endpointaccess-vpcsecuritygroup-status): String
  [VpcSecurityGroupId](#cfn-redshift-endpointaccess-vpcsecuritygroup-vpcsecuritygroupid): String
```

## Properties
<a name="aws-properties-redshift-endpointaccess-vpcsecuritygroup-properties"></a>

`Status`  <a name="cfn-redshift-endpointaccess-vpcsecuritygroup-status"></a>
The status of the endpoint.  
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcSecurityGroupId`  <a name="cfn-redshift-endpointaccess-vpcsecuritygroup-vpcsecuritygroupid"></a>
The identifier of the VPC security group.  
*Required*: No  
*Type*: String  
*Maximum*: `2147483647`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)