endpoint_access

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

Overview

Name	endpoint_access
Type	Resource
Id	aws.redshift_serverless.endpoint_access

Fields

The following fields are returned by SELECT queries:

get_endpoint_access

Name	Datatype	Description
address	string	The DNS address of the endpoint.
endpoint_arn	string	The Amazon Resource Name (ARN) of the VPC endpoint.
endpoint_create_time	string (date-time)	The time that the endpoint was created.
endpoint_name	string	The name of the VPC endpoint.
endpoint_status	string	The status of the VPC endpoint.
port	integer	The port number on which Amazon Redshift Serverless accepts incoming connections.
subnet_ids	array	The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpc_endpoint	object	The connection endpoint for connecting to Amazon Redshift Serverless.
vpc_security_groups	array	The security groups associated with the endpoint.
workgroup_name	string	The name of the workgroup associated with the endpoint.

list_endpoint_access

Name	Datatype	Description
address	string	The DNS address of the endpoint.
endpoint_arn	string	The Amazon Resource Name (ARN) of the VPC endpoint.
endpoint_create_time	string (date-time)	The time that the endpoint was created.
endpoint_name	string	The name of the VPC endpoint.
endpoint_status	string	The status of the VPC endpoint.
port	integer	The port number on which Amazon Redshift Serverless accepts incoming connections.
subnet_ids	array	The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpc_endpoint	object	The connection endpoint for connecting to Amazon Redshift Serverless.
vpc_security_groups	array	The security groups associated with the endpoint.
workgroup_name	string	The name of the workgroup associated with the endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_endpoint_access	select	region		Returns information, such as the name, about a VPC endpoint.
list_endpoint_access	select	region		Returns an array of EndpointAccess objects and relevant information.
create_endpoint_access	insert	region, endpointName, subnetIds, workgroupName		Creates an Amazon Redshift Serverless managed VPC endpoint.
update_endpoint_access	update	region, endpointName		Updates an Amazon Redshift Serverless managed endpoint.
delete_endpoint_access	delete	region		Deletes an Amazon Redshift Serverless managed VPC endpoint.

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)

SELECT examples

get_endpoint_access

Returns information, such as the name, about a VPC endpoint.

SELECT
address,
endpoint_arn,
endpoint_create_time,
endpoint_name,
endpoint_status,
port,
subnet_ids,
vpc_endpoint,
vpc_security_groups,
workgroup_name
FROM aws.redshift_serverless.endpoint_access
WHERE region = '{{ region }}' -- required
;

list_endpoint_access

Returns an array of EndpointAccess objects and relevant information.

SELECT
address,
endpoint_arn,
endpoint_create_time,
endpoint_name,
endpoint_status,
port,
subnet_ids,
vpc_endpoint,
vpc_security_groups,
workgroup_name
FROM aws.redshift_serverless.endpoint_access
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_endpoint_access

Creates an Amazon Redshift Serverless managed VPC endpoint.

INSERT INTO aws.redshift_serverless.endpoint_access (
endpointName,
ownerAccount,
subnetIds,
vpcSecurityGroupIds,
workgroupName,
region
)
SELECT 
'{{ endpointName }}' /* required */,
'{{ ownerAccount }}',
'{{ subnetIds }}' /* required */,
'{{ vpcSecurityGroupIds }}',
'{{ workgroupName }}' /* required */,
'{{ region }}'
RETURNING
endpoint
;

Manifest

# Description fields are for documentation purposes
- name: endpoint_access
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the endpoint_access resource.
  - name: endpointName
    value: "{{ endpointName }}"
    description: |
      The name of the VPC endpoint. 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.
  - name: ownerAccount
    value: "{{ ownerAccount }}"
    description: |
      The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
    description: |
      The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
  - name: vpcSecurityGroupIds
    value:
      - "{{ vpcSecurityGroupIds }}"
    description: |
      The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
  - name: workgroupName
    value: "{{ workgroupName }}"
    description: |
      The name of the workgroup to associate with the VPC endpoint.

UPDATE examples

update_endpoint_access

Updates an Amazon Redshift Serverless managed endpoint.

UPDATE aws.redshift_serverless.endpoint_access
SET 
endpointName = '{{ endpointName }}',
vpcSecurityGroupIds = '{{ vpcSecurityGroupIds }}'
WHERE 
region = '{{ region }}' --required
AND endpointName = '{{ endpointName }}' --required
RETURNING
endpoint;

DELETE examples

delete_endpoint_access

Deletes an Amazon Redshift Serverless managed VPC endpoint.

DELETE FROM aws.redshift_serverless.endpoint_access
WHERE region = '{{ region }}' --required
;