create_vpc_ingress_connection

AppRunner.Client.create_vpc_ingress_connection(**kwargs)

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_ingress_connection(
    ServiceArn='string',
    VpcIngressConnectionName='string',
    IngressVpcConfiguration={
        'VpcId': 'string',
        'VpcEndpointId': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• ServiceArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

• VpcIngressConnectionName (string) --

  [REQUIRED]

  A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.

• IngressVpcConfiguration (dict) --

  [REQUIRED]

  Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

  • VpcId (string) --

    The ID of the VPC that is used for the VPC endpoint.

  • VpcEndpointId (string) --

    The ID of the VPC endpoint that your App Runner service connects to.

• Tags (list) --

  An optional list of metadata items that you can associate with the VPC Ingress Connection 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

{
    'VpcIngressConnection': {
        'VpcIngressConnectionArn': 'string',
        'VpcIngressConnectionName': 'string',
        'ServiceArn': 'string',
        'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED',
        'AccountId': 'string',
        'DomainName': 'string',
        'IngressVpcConfiguration': {
            'VpcId': 'string',
            'VpcEndpointId': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • VpcIngressConnection (dict) --

    A description of the App Runner VPC Ingress Connection resource that's created by this request.

    • VpcIngressConnectionArn (string) --

      The Amazon Resource Name (ARN) of the VPC Ingress Connection.

    • VpcIngressConnectionName (string) --

      The customer-provided VPC Ingress Connection name.

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

    • Status (string) --

      The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE , PENDING_CREATION , PENDING_UPDATE , PENDING_DELETION , FAILED_CREATION , FAILED_UPDATE , FAILED_DELETION , and DELETED ..

    • AccountId (string) --

      The Account Id you use to create the VPC Ingress Connection resource.

    • DomainName (string) --

      The domain name associated with the VPC Ingress Connection resource.

    • IngressVpcConfiguration (dict) --

      Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

      • VpcId (string) --

        The ID of the VPC that is used for the VPC endpoint.

      • VpcEndpointId (string) --

        The ID of the VPC endpoint that your App Runner service connects to.

    • CreatedAt (datetime) --

      The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

      • Type: Timestamp
      • Required: Yes

    • DeletedAt (datetime) --

      The time when the App Runner service was deleted. It's in the Unix time stamp format.

      • Type: Timestamp
      • Required: No

Exceptions

• AppRunner.Client.exceptions.InvalidRequestException
• AppRunner.Client.exceptions.InvalidStateException
• AppRunner.Client.exceptions.InternalServiceErrorException
• AppRunner.Client.exceptions.ServiceQuotaExceededException