endpoint_authorizations

Creates, updates, deletes, gets or lists an endpoint_authorizations resource.

Overview

Name	endpoint_authorizations
Type	Resource
Id	aws.redshift.endpoint_authorizations

Fields

The following fields are returned by SELECT queries:

describe_endpoint_authorization

Name	Datatype	Description
allowed_all_vpcs	boolean	Indicates whether all VPCs in the grantee account are allowed access to the cluster.
allowed_vpcs	string	The VPCs allowed access to the cluster.
authorize_time	string	The time (UTC) when the authorization was created.
cluster_identifier	string	The cluster identifier.
cluster_status	string	The status of the cluster.
endpoint_count	integer	The number of Redshift-managed VPC endpoints created for the authorization.
grantee	string	The Amazon Web Services account ID of the grantee of the cluster.
grantor	string	The Amazon Web Services account ID of the cluster owner.
status	string	The status of the authorization action.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_endpoint_authorization	select	region	ClusterIdentifier, Account, Grantee, MaxRecords, Marker	Describes an endpoint authorization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Account	string	The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.
ClusterIdentifier	string	The cluster identifier of the cluster to access.
Grantee	boolean	Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.
Marker	string	An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

SELECT examples

describe_endpoint_authorization

Describes an endpoint authorization.

SELECT
allowed_all_vpcs,
allowed_vpcs,
authorize_time,
cluster_identifier,
cluster_status,
endpoint_count,
grantee,
grantor,
status
FROM aws.redshift.endpoint_authorizations
WHERE region = '{{ region }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND Account = '{{ Account }}'
AND Grantee = '{{ Grantee }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;