CreateVpcConnector
Create an AWS 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).
Request Syntax
{
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcConnectorName": "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.
- SecurityGroups
-
A list of IDs of security groups that App Runner should use for access to AWS 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.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 51200.
Pattern:
.*Required: No
- Subnets
-
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.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 51200.
Pattern:
.*Required: Yes
- Tags
-
A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
Type: Array of Tag objects
Required: No
- VpcConnectorName
-
A name for the VPC connector.
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
{
"VpcConnector": {
"CreatedAt": number,
"DeletedAt": number,
"SecurityGroups": [ "string" ],
"Status": "string",
"Subnets": [ "string" ],
"VpcConnectorArn": "string",
"VpcConnectorName": "string",
"VpcConnectorRevision": number
}
}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.
- VpcConnector
-
A description of the App Runner VPC connector that's created by this request.
Type: VpcConnector 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
- 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 connector
This example illustrates how to create a VPC connector.
Sample Request
$ aws apprunner create-vpc-connector --cli-input-json "`cat`"
{
"VpcConnectorName": "my-vpc-connector",
"Subnets": ["subnet-123", "subnet-456"],
"SecurityGroups": ["sg-123", "sg-456"]
}Sample Response
{
"VpcConnector": {
"VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpc-connector/1/3f2eb10e2c494674952026f646844e3d",
"VpcConnectorName": "my-vpc-connector",
"VpcConnectorRevision": 1,
"Subnets": ["subnet-123", "subnet-456"],
"SecurityGroups": ["sg-123", "sg-456"],
"Status": "ACTIVE",
"CreatedAt": "2021-08-18T23:36:45.374Z"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
