[ aws . redshift ]

describe-endpoint-access

Description

Describes a Redshift-managed VPC endpoint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-endpoint-access is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: EndpointAccessList

Synopsis

  describe-endpoint-access
[--cluster-identifier <value>]
[--resource-owner <value>]
[--endpoint-name <value>]
[--vpc-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cluster-identifier (string)

The cluster identifier associated with the described endpoint.

--resource-owner (string)

The Amazon Web Services account ID of the owner of the cluster.

--endpoint-name (string)

The name of the endpoint to be described.

--vpc-id (string)

The virtual private cloud (VPC) identifier with access to the cluster.

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

See ‘aws help’ for descriptions of global parameters.

Output

EndpointAccessList -> (list)

The list of endpoints with access to the cluster.

(structure)

Describes a Redshift-managed VPC endpoint.

ClusterIdentifier -> (string)

The cluster identifier of the cluster associated with the endpoint.

ResourceOwner -> (string)

The Amazon Web Services account ID of the owner of the cluster.

SubnetGroupName -> (string)

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

EndpointStatus -> (string)

The status of the endpoint.

EndpointName -> (string)

The name of the endpoint.

EndpointCreateTime -> (timestamp)

The time (UTC) that the endpoint was created.

Port -> (integer)

The port number on which the cluster accepts incoming connections.

Address -> (string)

The DNS address of the endpoint.

VpcSecurityGroups -> (list)

The security groups associated with the endpoint.

(structure)

Describes the members of a VPC security group.

VpcSecurityGroupId -> (string)

The identifier of the VPC security group.

Status -> (string)

The status of the VPC security group.

VpcEndpoint -> (structure)

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcEndpointId -> (string)

The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

VpcId -> (string)

The VPC identifier that the endpoint is associated.

NetworkInterfaces -> (list)

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

(structure)

Describes a network interface.

NetworkInterfaceId -> (string)

The network interface identifier.

SubnetId -> (string)

The subnet identifier.

PrivateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

AvailabilityZone -> (string)

The Availability Zone.

Marker -> (string)

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.