Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateVpcIngressConnection

Create an AWS 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.

Request Syntax


{
   "IngressVpcConfiguration": { 
      "VpcEndpointId": "string",
      "VpcId": "string"
   },
   "ServiceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VpcIngressConnectionName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IngressVpcConfiguration

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

Type: IngressVpcConfiguration object

Required: Yes

ServiceArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}

Required: Yes

Tags

An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.

Type: Array of Tag objects

Required: No

VpcIngressConnectionName

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

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{3,39}

Required: Yes

Response Syntax


{
   "VpcIngressConnection": { 
      "AccountId": "string",
      "CreatedAt": number,
      "DeletedAt": number,
      "DomainName": "string",
      "IngressVpcConfiguration": { 
         "VpcEndpointId": "string",
         "VpcId": "string"
      },
      "ServiceArn": "string",
      "Status": "string",
      "VpcIngressConnectionArn": "string",
      "VpcIngressConnectionName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VpcIngressConnection

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

Type: VpcIngressConnection object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceErrorException

An unexpected service exception occurred.

HTTP Status Code: 500

InvalidRequestException

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

HTTP Status Code: 400

InvalidStateException

You can't perform this action when the resource is in its current state.

HTTP Status Code: 400

ServiceQuotaExceededException

App Runner can't create this resource. You've reached your account quota for this resource type.

For App Runner per-resource quotas, see AWS App Runner endpoints and quotas in the AWS General Reference.

HTTP Status Code: 400

Examples

Create a VPC Ingress Connection

This example illustrates how to create a VPC Ingress Connection.

Sample Request


$ aws apprunner create-vpc-ingress-connection --cli-input-json "`cat`"
{
    "IngressVpcConfiguration": {
        "VpcEndpointId": "vpce-1a2b3c4d",
        "VpcId": "vpc-4a5b6c7d"
    },
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/my-service",
    "VpcIngressConnectionName": "my-ingress-connection-name"
}

Sample Response


{
    "AccountId": "123456789012",
    "CreatedAt": "2022-09-18T23:36:45.374Z",
    "DomainName": "psbqam834h.us-east-1.awsapprunner.com",
    "IngressVpcConfiguration": {
        "VpcEndpointId": "vpce-1a2b3c4d",
        "VpcId": "vpc-4a5b6c7d"
    },
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/my-service",
    "Status": "PENDING_CREATION",
    "VpcIngressConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:vpcingressconnection/my-ingress-connection-name/3f2eb10e2c494674952026f646844e3d",
    "VpcIngressConnectionName": "my-ingress-connection-name"
}