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

UpdateVpcIngressConnection

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

AVAILABLE
FAILED_CREATION
FAILED_UPDATE

Request Syntax


{
   "IngressVpcConfiguration": { 
      "VpcEndpointId": "string",
      "VpcId": "string"
   },
   "VpcIngressConnectionArn": "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 update the VPC Ingress Connection resource.

Type: IngressVpcConfiguration object

Required: Yes

VpcIngressConnectionArn

The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.

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

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 updated 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

ResourceNotFoundException

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.

HTTP Status Code: 400

Examples

Updating App Runner VPC Ingress Connections

This example illustrates how to update App Runner VPC Ingress Connections.

Sample Request


$ aws apprunner update-vpc-ingress-connection --cli-input-json "`cat`"
{
    "IngressVpcConfiguration": {
        "VpcEndpointId": "vpce-1a2b3c4d",
        "VpcId": "vpc-4a5b6c7d"
    },
    "VpcIngressConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:vpcingressconnection/my-ingress-connection-name/3f2eb10e2c494674952026f646844e3d"
}

Sample Response


{
    "VpcIngressConnection": {
        "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_UPDATE",
        "VpcIngressConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:vpcingressconnection/my-ingress-connection-name/3f2eb10e2c494674952026f646844e3d",
        "VpcIngressConnectionName": "my-ingress-connection-name"
    }
}