AWS Outposts

Gets the private connectivity configuration for the specified Outpost.

See also: AWS API Documentation

Request Syntax

client.get_private_connectivity_config(
    OutpostId='string'
)

type OutpostId:

string

param OutpostId:

[REQUIRED]

The ID or ARN of the Outpost.

rtype:

dict

returns:

Response Syntax

{
    'PrivateConnectivityConfig': {
        'RoleArn': 'string',
        'PrivateConnectivityStatus': 'ENABLED'|'DISABLED',
        'VpcInformationList': [
            {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'VpcEndpointId': 'string'
            },
        ],
        'ProvisioningRoleArn': 'string'
    }
}

Response Structure

• (dict) --

  • PrivateConnectivityConfig (dict) --

    The private connectivity configuration for the Outpost.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the service-linked role that Amazon Web Services Outposts creates and uses to provision and attach the network interfaces for private connectivity in your VPC. The role's permissions are scoped to the specific Outpost and VPC.

    • PrivateConnectivityStatus (string) --

      The status of private connectivity for the Outpost. Valid values are ENABLED and DISABLED.

    • VpcInformationList (list) --

      Information about the VPC used for private connectivity.

      • (dict) --

        Information about a VPC used for private connectivity, including its subnets and an associated VPC endpoint.

        • VpcId (string) --

          The ID of the VPC used for private connectivity.

        • SubnetIds (list) --

          The IDs of the subnets associated with the VPC endpoint. Currently, only one subnet is supported.

          • (string) --

        • VpcEndpointId (string) --

          The ID of the interface VPC endpoint for the Amazon Web Services Outposts service. When specified, the endpoint must be in the available state and the specified subnets must be associated with it.

    • ProvisioningRoleArn (string) --

      The Amazon Resource Name (ARN) of the provisioning role in your account that Amazon Web Services Outposts uses to establish the service link connection during Outpost installation. This field is present only when VPC endpoint-based provisioning is configured.

Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home Amazon Web Services Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure.

See also: AWS API Documentation

Request Syntax

client.create_private_connectivity_config(
    OutpostId='string',
    VpcInformationList=[
        {
            'VpcId': 'string',
            'SubnetIds': [
                'string',
            ],
            'VpcEndpointId': 'string'
        },
    ]
)

type OutpostId:

string

param OutpostId:

[REQUIRED]

The ID or ARN of the Outpost.

type VpcInformationList:

list

param VpcInformationList:

[REQUIRED]

Information about the VPC used for private connectivity, including the VPC, its subnets, and an associated VPC endpoint. You can specify at most one entry.

• (dict) --

  Information about a VPC used for private connectivity, including its subnets and an associated VPC endpoint.

  • VpcId (string) --

    The ID of the VPC used for private connectivity.

  • SubnetIds (list) --

    The IDs of the subnets associated with the VPC endpoint. Currently, only one subnet is supported.

    • (string) --

  • VpcEndpointId (string) --

    The ID of the interface VPC endpoint for the Amazon Web Services Outposts service. When specified, the endpoint must be in the available state and the specified subnets must be associated with it.

rtype:

dict

returns:

Response Syntax

{
    'PrivateConnectivityConfig': {
        'RoleArn': 'string',
        'PrivateConnectivityStatus': 'ENABLED'|'DISABLED',
        'VpcInformationList': [
            {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'VpcEndpointId': 'string'
            },
        ],
        'ProvisioningRoleArn': 'string'
    },
    'OutpostId': 'string'
}

Response Structure

• (dict) --

  • PrivateConnectivityConfig (dict) --

    The private connectivity configuration for the Outpost.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the service-linked role that Amazon Web Services Outposts creates and uses to provision and attach the network interfaces for private connectivity in your VPC. The role's permissions are scoped to the specific Outpost and VPC.

    • PrivateConnectivityStatus (string) --

      The status of private connectivity for the Outpost. Valid values are ENABLED and DISABLED.

    • VpcInformationList (list) --

      Information about the VPC used for private connectivity.

      • (dict) --

        Information about a VPC used for private connectivity, including its subnets and an associated VPC endpoint.

        • VpcId (string) --

          The ID of the VPC used for private connectivity.

        • SubnetIds (list) --

          The IDs of the subnets associated with the VPC endpoint. Currently, only one subnet is supported.

          • (string) --

        • VpcEndpointId (string) --

          The ID of the interface VPC endpoint for the Amazon Web Services Outposts service. When specified, the endpoint must be in the available state and the specified subnets must be associated with it.

    • ProvisioningRoleArn (string) --

      The Amazon Resource Name (ARN) of the provisioning role in your account that Amazon Web Services Outposts uses to establish the service link connection during Outpost installation. This field is present only when VPC endpoint-based provisioning is configured.

  • OutpostId (string) --

    The ID of the Outpost.