AWS::Redshift::EndpointAccess

Redshift EndpointAccess

Resource schema for a Redshift-managed VPC endpoint.

Properties

5 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`ClusterIdentifier`	`string`	RequiredCreate-only
`EndpointName`	`string`	RequiredCreate-only
`SubnetGroupName`	`string`	RequiredCreate-only
`VpcSecurityGroupIds`	`Array<string>`	Required
`ResourceOwner`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Address`	`string`	The DNS address of the endpoint.
`EndpointCreateTime`	`string`	The time (UTC) that the endpoint was created.
`EndpointStatus`	`string`	The status of the endpoint.
`Port`	`integer`	The port number on which the cluster accepts incoming connections.
`VpcEndpoint`	`object`	The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
`VpcSecurityGroups`	`Array<VpcSecurityGroup>`	A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Redshift::EndpointAccess

Resources:
  MyResource:
    Type: AWS::Redshift::EndpointAccess
    Properties:
      ClusterIdentifier: "my-clusteridentifier"
      SubnetGroupName: "my-subnetgroupname"
      EndpointName: "my-endpointname"
      VpcSecurityGroupIds: "my-vpcsecuritygroupids"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

redshift:DescribeEndpointAccessec2:DescribeClientVpnEndpointsec2:DescribeVpcEndpointec2:DescribeVpcAttributeec2:DescribeSecurityGroupsec2:DescribeAddressesec2:DescribeInternetGatewaysec2:DescribeSubnets

create

redshift:CreateEndpointAccessredshift:DescribeEndpointAccessec2:CreateClientVpnEndpointec2:CreateVpcEndpointec2:DescribeVpcAttributeec2:DescribeSecurityGroupsec2:DescribeAddressesec2:DescribeInternetGateways

update

redshift:DescribeEndpointAccessredshift:ModifyEndpointAccessec2:ModifyClientVpnEndpointec2:ModifyVpcEndpointec2:DescribeVpcAttributeec2:DescribeSecurityGroupsec2:DescribeAddressesec2:DescribeInternetGateways

list

redshift:DescribeEndpointAccessec2:DescribeClientVpnEndpointsec2:DescribeVpcEndpointsec2:DescribeVpcAttributeec2:DescribeSecurityGroupsec2:DescribeAddressesec2:DescribeInternetGatewaysec2:DescribeSubnets

delete

redshift:DeleteEndpointAccessredshift:DescribeEndpointAccessec2:DeleteClientVpnEndpointec2:DeleteVpcEndpointec2:DescribeVpcAttributeec2:DescribeSecurityGroupsec2:DescribeAddressesec2:DescribeInternetGateways

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceRedshift

Properties11

Required4

TaggingNot supported

Primary IDEndpointName

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

EndpointNameClusterIdentifierResourceOwnerSubnetGroupName

Related Resources

External Links

AWS Documentation