AppRunner / Client / create_vpc_connector

create_vpc_connector#

AppRunner.Client.create_vpc_connector(**kwargs)#

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_connector(
    VpcConnectorName='string',
    Subnets=[
        'string',
    ],
    SecurityGroups=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • VpcConnectorName (string) –

    [REQUIRED]

    A name for the VPC connector.

  • Subnets (list) –

    [REQUIRED]

    A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

    Note

    App Runner currently only provides support for IPv4.

    • (string) –

  • SecurityGroups (list) –

    A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

    • (string) –

  • Tags (list) –

    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

    • (dict) –

      Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

      • Key (string) –

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'VpcConnector': {
        'VpcConnectorName': 'string',
        'VpcConnectorArn': 'string',
        'VpcConnectorRevision': 123,
        'Subnets': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'Status': 'ACTIVE'|'INACTIVE',
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • VpcConnector (dict) –

      A description of the App Runner VPC connector that’s created by this request.

      • VpcConnectorName (string) –

        The customer-provided VPC connector name.

      • VpcConnectorArn (string) –

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision (integer) –

        The revision of this VPC connector. It’s unique among all the active connectors ( "Status": "ACTIVE") that share the same Name.

        Note

        At this time, App Runner supports only one revision per name.

      • Subnets (list) –

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

        • (string) –

      • SecurityGroups (list) –

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

        • (string) –

      • Status (string) –

        The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can’t be used. Inactive connector revisions are permanently removed some time after they are deleted.

      • CreatedAt (datetime) –

        The time when the VPC connector was created. It’s in Unix time stamp format.

      • DeletedAt (datetime) –

        The time when the VPC connector was deleted. It’s in Unix time stamp format.

Exceptions