endpoint_accesses

Creates, updates, deletes or gets an endpoint_access resource or lists endpoint_accesses in a region

Overview

Name	endpoint_accesses
Type	Resource
Description	Resource schema for a Redshift-managed VPC endpoint.
Id	awscc.redshift.endpoint_accesses

Fields

get (all properties)

Name	Datatype	Description
endpoint_status	string	The status of the endpoint.
▶vpc_endpoint	object	The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
address	string	The DNS address of the endpoint.
endpoint_name	string	The name of the endpoint.
vpc_security_group_ids	array	A list of vpc security group ids to apply to the created endpoint access.
resource_owner	string	The AWS account ID of the owner of the cluster.
subnet_group_name	string	The subnet group name where Amazon Redshift chooses to deploy the endpoint.
port	integer	The port number on which the cluster accepts incoming connections.
endpoint_create_time	string	The time (UTC) that the endpoint was created.
cluster_identifier	string	A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
▶vpc_security_groups	array	A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
endpoint_name	string	The name of the endpoint.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoint_accesses	INSERT	ClusterIdentifier, SubnetGroupName, EndpointName, VpcSecurityGroupIds, region
delete_resource	endpoint_accesses	DELETE	Identifier, region
update_resource	endpoint_accesses	UPDATE	Identifier, PatchDocument, region
list_resources	endpoint_accesses_list_only	SELECT	region
get_resource	endpoint_accesses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual endpoint_access.

SELECT
  region,
  endpoint_status,
  vpc_endpoint,
  address,
  endpoint_name,
  vpc_security_group_ids,
  resource_owner,
  subnet_group_name,
  port,
  endpoint_create_time,
  cluster_identifier,
  vpc_security_groups
FROM awscc.redshift.endpoint_accesses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ endpoint_name }}';

list (identifiers only)

Lists all endpoint_accesses in a region.

SELECT
  region,
  endpoint_name
FROM awscc.redshift.endpoint_accesses_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.redshift.endpoint_accesses (
  EndpointName,
  VpcSecurityGroupIds,
  SubnetGroupName,
  ClusterIdentifier,
  region
)
SELECT
  '{{ endpoint_name }}',
  '{{ vpc_security_group_ids }}',
  '{{ subnet_group_name }}',
  '{{ cluster_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.redshift.endpoint_accesses (
  EndpointName,
  VpcSecurityGroupIds,
  ResourceOwner,
  SubnetGroupName,
  ClusterIdentifier,
  region
)
SELECT
  '{{ endpoint_name }}',
  '{{ vpc_security_group_ids }}',
  '{{ resource_owner }}',
  '{{ subnet_group_name }}',
  '{{ 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_access
  props:
    - name: endpoint_name
      value: '{{ endpoint_name }}'
    - name: vpc_security_group_ids
      value:
        - '{{ vpc_security_group_ids[0] }}'
    - name: resource_owner
      value: '{{ resource_owner }}'
    - name: subnet_group_name
      value: '{{ subnet_group_name }}'
    - name: cluster_identifier
      value: '{{ cluster_identifier }}'

UPDATE example

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

/*+ update */
UPDATE awscc.redshift.endpoint_accesses
SET PatchDocument = string('{{ {
    "VpcSecurityGroupIds": vpc_security_group_ids
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ endpoint_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.redshift.endpoint_accesses
WHERE
  Identifier = '{{ endpoint_name }}' 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_accesses resource, the following permissions are required:

Read

redshift:DescribeEndpointAccess,
ec2:DescribeClientVpnEndpoints,
ec2:DescribeVpcEndpoint,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets

Create

redshift:CreateEndpointAccess,
redshift:DescribeEndpointAccess,
ec2:CreateClientVpnEndpoint,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets

Update

redshift:DescribeEndpointAccess,
redshift:ModifyEndpointAccess,
ec2:ModifyClientVpnEndpoint,
ec2:ModifyVpcEndpoint,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets

List

redshift:DescribeEndpointAccess,
ec2:DescribeClientVpnEndpoints,
ec2:DescribeVpcEndpoints,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets

Delete

redshift:DeleteEndpointAccess,
redshift:DescribeEndpointAccess,
ec2:DeleteClientVpnEndpoint,
ec2:DeleteVpcEndpoint,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets,
ec2:DescribeVpcEndpoint