[ aws . redshift-serverless ]

create-endpoint-access

Description

Creates an Amazon Redshift Serverless managed VPC endpoint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-endpoint-access
--endpoint-name <value>
--subnet-ids <value>
[--vpc-security-group-ids <value>]
--workgroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--endpoint-name (string)

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.

--subnet-ids (list)

The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

(string)

Syntax:

"string" "string" ...

--vpc-security-group-ids (list)

The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

(string)

Syntax:

"string" "string" ...

--workgroup-name (string)

The name of the workgroup to associate with the VPC endpoint.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

endpoint -> (structure)

The created VPC endpoint.

address -> (string)

The DNS address of the endpoint.

endpointArn -> (string)

The Amazon Resource Name (ARN) of the VPC endpoint.

endpointCreateTime -> (timestamp)

The time that the endpoint was created.

endpointName -> (string)

The name of the VPC endpoint.

endpointStatus -> (string)

The status of the VPC endpoint.

port -> (integer)

The port number on which Amazon Redshift Serverless accepts incoming connections.

subnetIds -> (list)

The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

(string)

vpcEndpoint -> (structure)

The connection endpoint for connecting to Amazon Redshift Serverless.

networkInterfaces -> (list)

One or more network interfaces of the endpoint. Also known as an interface endpoint.

(structure)

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

availabilityZone -> (string)

The availability Zone.

networkInterfaceId -> (string)

The unique identifier of the network interface.

privateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

subnetId -> (string)

The unique identifier of the subnet.

vpcEndpointId -> (string)

The connection endpoint ID for connecting to Amazon Redshift Serverless.

vpcId -> (string)

The VPC identifier that the endpoint is associated with.

vpcSecurityGroups -> (list)

The security groups associated with the endpoint.

(structure)

Describes the members of a VPC security group.

status -> (string)

The status of the VPC security group.

vpcSecurityGroupId -> (string)

The unique identifier of the VPC security group.

workgroupName -> (string)

The name of the workgroup associated with the endpoint.