Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Redshift::EndpointAuthorization",
"Properties" : {
"Account" : String,
"ClusterIdentifier" : String,
"Force" : Boolean,
"VpcIds" : [ String, ... ]
}
}
YAML
Type: AWS::Redshift::EndpointAuthorization
Properties:
Account: String
ClusterIdentifier: String
Force: Boolean
VpcIds:
- String
Properties
-
The AWS account ID of either the cluster owner (grantor) or grantee. If
Granteeparameter is true, then theAccountvalue is of the grantor.Required: Yes
Type: String
Pattern:
^\d{12}$Update requires: Replacement
-
The cluster identifier.
Required: Yes
Type: String
Pattern:
^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$Update requires: Replacement
-
Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
Required: No
Type: Boolean
Update requires: No interruption
-
The virtual private cloud (VPC) identifiers to grant access to.
Required: No
Type: Array of String
Update requires: No interruption
Return values
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.
AllowedAllVPCs-
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
AllowedVPCs-
The VPCs allowed access to the cluster.
AuthorizeTime-
The time (UTC) when the authorization was created.
ClusterStatus-
The status of the cluster.
EndpointCount-
The number of Redshift-managed VPC endpoints created for the authorization.
Grantee-
The AWS account ID of the grantee of the cluster.
Grantor-
The AWS account ID of the cluster owner.
Status-
The status of the authorization action.
