AWS::Redshift::EndpointAccess

Creates a Redshift-managed VPC endpoint.

Syntax

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

JSON

{
  "Type" : "AWS::Redshift::EndpointAccess",
  "Properties" : {
      "ClusterIdentifier" : String,
      "EndpointName" : String,
      "ResourceOwner" : String,
      "SubnetGroupName" : String,
      "VpcSecurityGroupIds" : [ String, ... ]
    }
}

YAML

Type: AWS::Redshift::EndpointAccess
Properties:
  ClusterIdentifier: String
  EndpointName: String
  ResourceOwner: String
  SubnetGroupName: String
  VpcSecurityGroupIds: 
    - String

Properties

ClusterIdentifier

The cluster identifier of the cluster associated with the endpoint.

Required: Yes

Type: String

Maximum: 2147483647

Update requires: Replacement

EndpointName

The name of the endpoint.

Required: Yes

Type: String

Pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$

Update requires: Replacement

ResourceOwner

The AWS account ID of the owner of the cluster.

Required: No

Type: String

Pattern: ^\d{12}$

Update requires: Replacement

SubnetGroupName

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

VpcSecurityGroupIds

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

Return values

Ref

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 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.

Address

The DNS address of the endpoint.

EndpointCreateTime

The time (UTC) that the endpoint was created.

EndpointStatus

The status of the endpoint.

Port

The port number on which the cluster accepts incoming connections.

VpcEndpoint.VpcEndpointId

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

VpcEndpoint.VpcId

The VPC identifier that the endpoint is associated.

VpcSecurityGroups

The security groups associated with the endpoint.