endpoint_authorizations

Creates, updates, deletes or gets an endpoint_authorization resource or lists endpoint_authorizations in a region

Overview

Name	endpoint_authorizations
Type	Resource
Description	Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Id	awscc.redshift.endpoint_authorizations

Fields

get (all properties)

Name	Datatype	Description
status	string	The status of the authorization action.
grantee	string	The AWS account ID of the grantee of the cluster.
endpoint_count	integer	The number of Redshift-managed VPC endpoints created for the authorization.
authorize_time	string	The time (UTC) when the authorization was created.
allowed_vpcs	array	The VPCs allowed access to the cluster.
force	boolean	Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
allowed_all_vpcs	boolean	Indicates whether all VPCs in the grantee account are allowed access to the cluster.
vpc_ids	array	The virtual private cloud (VPC) identifiers to grant or revoke access to.
cluster_identifier	string	The cluster identifier.
cluster_status	string	The status of the cluster.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cluster_identifier	string	The cluster identifier.
region	string	AWS region.

For more information, see AWS::Redshift::EndpointAuthorization.

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoint_authorizations	INSERT	ClusterIdentifier, Account, region
delete_resource	endpoint_authorizations	DELETE	Identifier, region
update_resource	endpoint_authorizations	UPDATE	Identifier, PatchDocument, region
list_resources	endpoint_authorizations_list_only	SELECT	region
get_resource	endpoint_authorizations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual endpoint_authorization.

SELECT
  region,
  status,
  grantee,
  account,
  grantor,
  endpoint_count,
  authorize_time,
  allowed_vpcs,
  force,
  allowed_all_vpcs,
  vpc_ids,
  cluster_identifier,
  cluster_status
FROM awscc.redshift.endpoint_authorizations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_identifier }}|{{ account }}';

list (identifiers only)

Lists all endpoint_authorizations in a region.

SELECT
  region,
  cluster_identifier,
  account
FROM awscc.redshift.endpoint_authorizations_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new endpoint_authorization resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.redshift.endpoint_authorizations (
  Account,
  ClusterIdentifier,
  region
)
SELECT
  '{{ account }}',
  '{{ cluster_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.redshift.endpoint_authorizations (
  Account,
  Force,
  VpcIds,
  ClusterIdentifier,
  region
)
SELECT
  '{{ account }}',
  '{{ force }}',
  '{{ vpc_ids }}',
  '{{ cluster_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: endpoint_authorization
  props:
    - name: account
      value: '{{ account }}'
    - name: force
      value: '{{ force }}'
    - name: vpc_ids
      value:
        - '{{ vpc_ids[0] }}'
    - name: cluster_identifier
      value: '{{ cluster_identifier }}'

UPDATE example

Use the following StackQL query and manifest file to update a endpoint_authorization resource, using stack-deploy.

/*+ update */
UPDATE awscc.redshift.endpoint_authorizations
SET PatchDocument = string('{{ {
    "Force": force,
    "VpcIds": vpc_ids
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_identifier }}|{{ account }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.redshift.endpoint_authorizations
WHERE
  Identifier = '{{ cluster_identifier }}|{{ account }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the endpoint_authorizations resource, the following permissions are required:

Read

redshift:DescribeEndpointAuthorization

Create

redshift:AuthorizeEndpointAccess,
redshift:DescribeEndpointAuthorization

Update

redshift:AuthorizeEndpointAccess,
redshift:DescribeEndpointAuthorization,
redshift:RevokeEndpointAccess

List

redshift:DescribeEndpointAuthorization

Delete

redshift:RevokeEndpointAccess,
redshift:DeleteEndpointAccess,
redshift:DescribeEndpointAuthorization,
ec2:DeleteClientVpnEndpoint,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets