Redshift / Client / create_endpoint_access

create_endpoint_access#

Redshift.Client.create_endpoint_access(**kwargs)#

Creates a Redshift-managed VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_endpoint_access(
    ClusterIdentifier='string',
    ResourceOwner='string',
    EndpointName='string',
    SubnetGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ]
)
Parameters:

  • ClusterIdentifier (string) – The cluster identifier of the cluster to access.

  • ResourceOwner (string) – The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

  • EndpointName (string) –

    [REQUIRED]

    The Redshift-managed VPC endpoint name.

    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.

  • SubnetGroupName (string) –

    [REQUIRED]

    The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

  • VpcSecurityGroupIds (list) –

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ClusterIdentifier': 'string',
    'ResourceOwner': 'string',
    'SubnetGroupName': 'string',
    'EndpointStatus': 'string',
    'EndpointName': 'string',
    'EndpointCreateTime': datetime(2015, 1, 1),
    'Port': 123,
    'Address': 'string',
    'VpcSecurityGroups': [
        {
            'VpcSecurityGroupId': 'string',
            'Status': 'string'
        },
    ],
    'VpcEndpoint': {
        'VpcEndpointId': 'string',
        'VpcId': 'string',
        'NetworkInterfaces': [
            {
                'NetworkInterfaceId': 'string',
                'SubnetId': 'string',
                'PrivateIpAddress': 'string',
                'AvailabilityZone': 'string',
                'Ipv6Address': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    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 (datetime) –

      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.

      • (dict) –

        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 (dict) –

      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.

        • (dict) –

          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.

          • Ipv6Address (string) –

            The IPv6 address of the network interface within the subnet.

Exceptions