CreateEndpointAccess
Creates a Redshift-managed VPC endpoint.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- EndpointName
-
The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- SubnetGroupName
-
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- ClusterIdentifier
-
The cluster identifier of the cluster to access.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- ResourceOwner
-
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
Response Elements
The following elements are returned by the service.
- Address
-
The DNS address of the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
- ClusterIdentifier
-
The cluster identifier of the cluster associated with the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
- EndpointCreateTime
-
The time (UTC) that the endpoint was created.
Type: Timestamp
- EndpointName
-
The name of the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
- EndpointStatus
-
The status of the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
- Port
-
The port number on which the cluster accepts incoming connections.
Type: Integer
- ResourceOwner
-
The Amazon Web Services account ID of the owner of the cluster.
Type: String
Length Constraints: Maximum length of 2147483647.
- SubnetGroupName
-
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
Type: String
Length Constraints: Maximum length of 2147483647.
- VpcEndpoint
-
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
Type: VpcEndpoint object
- VpcSecurityGroups.VpcSecurityGroup.N
-
The security groups associated with the endpoint.
Type: Array of VpcSecurityGroupMembership objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessToClusterDenied
-
You are not authorized to access the cluster.
HTTP Status Code: 400
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- ClusterSubnetGroupNotFoundFault
-
The cluster subnet group name does not refer to an existing cluster subnet group.
HTTP Status Code: 400
- EndpointAlreadyExists
-
The account already has a Redshift-managed VPC endpoint with the given identifier.
HTTP Status Code: 400
- EndpointsPerAuthorizationLimitExceeded
-
The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.
HTTP Status Code: 400
- EndpointsPerClusterLimitExceeded
-
The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.
HTTP Status Code: 400
- InvalidClusterSecurityGroupState
-
The state of the cluster security group is not
available.HTTP Status Code: 400
- InvalidClusterState
-
The specified cluster is not in the
availablestate.HTTP Status Code: 400
- UnauthorizedOperation
-
Your account is not authorized to perform the requested operation.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: