VPCLattice / Client / get_resource_configuration

get_resource_configuration#

VPCLattice.Client.get_resource_configuration(**kwargs)#

Retrieves information about the specified resource configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_configuration(
    resourceConfigurationIdentifier='string'
)
Parameters:

resourceConfigurationIdentifier (string) –

[REQUIRED]

The ID of the resource configuration.

Return type:

dict

Returns:

Response Syntax

{
    'allowAssociationToShareableServiceNetwork': True|False,
    'amazonManaged': True|False,
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'customDomainName': 'string',
    'failureReason': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'portRanges': [
        'string',
    ],
    'protocol': 'TCP',
    'resourceConfigurationDefinition': {
        'arnResource': {
            'arn': 'string'
        },
        'dnsResource': {
            'domainName': 'string',
            'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
        },
        'ipResource': {
            'ipAddress': 'string'
        }
    },
    'resourceConfigurationGroupId': 'string',
    'resourceGatewayId': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN'
}

Response Structure

  • (dict) –

    • allowAssociationToShareableServiceNetwork (boolean) –

      Specifies whether the resource configuration is associated with a sharable service network.

    • amazonManaged (boolean) –

      Indicates whether the resource configuration was created and is managed by Amazon.

    • arn (string) –

      The Amazon Resource Name (ARN) of the resource configuration.

    • createdAt (datetime) –

      The date and time that the resource configuration was created, in ISO-8601 format.

    • customDomainName (string) –

      The custom domain name of the resource configuration.

    • failureReason (string) –

      The reason the create-resource-configuration request failed.

    • id (string) –

      The ID of the resource configuration.

    • lastUpdatedAt (datetime) –

      The most recent date and time that the resource configuration was updated, in ISO-8601 format.

    • name (string) –

      The name of the resource configuration.

    • portRanges (list) –

      The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30

      • (string) –

    • protocol (string) –

      The TCP protocol accepted by the specified resource configuration.

    • resourceConfigurationDefinition (dict) –

      The resource configuration.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: arnResource, dnsResource, ipResource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • arnResource (dict) –

        The Amazon Resource Name (ARN) of the resource.

        • arn (string) –

          The Amazon Resource Name (ARN) of the resource.

      • dnsResource (dict) –

        The DNS name of the resource.

        • domainName (string) –

          The domain name of the resource.

        • ipAddressType (string) –

          The type of IP address.

      • ipResource (dict) –

        The IP resource.

        • ipAddress (string) –

          The IP address of the IP resource.

    • resourceConfigurationGroupId (string) –

      The ID of the group resource configuration.

    • resourceGatewayId (string) –

      The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN.

    • status (string) –

      The status of the resource configuration.

    • type (string) –

      The type of resource configuration.

      • SINGLE - A single resource.

      • GROUP - A group of resources.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

Exceptions