- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateVpcIngressConnectionCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppRunnerClient, CreateVpcIngressConnectionCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, CreateVpcIngressConnectionCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // CreateVpcIngressConnectionRequest
ServiceArn: "STRING_VALUE", // required
VpcIngressConnectionName: "STRING_VALUE", // required
IngressVpcConfiguration: { // IngressVpcConfiguration
VpcId: "STRING_VALUE",
VpcEndpointId: "STRING_VALUE",
},
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE",
Value: "STRING_VALUE",
},
],
};
const command = new CreateVpcIngressConnectionCommand(input);
const response = await client.send(command);
// { // CreateVpcIngressConnectionResponse
// VpcIngressConnection: { // VpcIngressConnection
// VpcIngressConnectionArn: "STRING_VALUE",
// VpcIngressConnectionName: "STRING_VALUE",
// ServiceArn: "STRING_VALUE",
// Status: "AVAILABLE" || "PENDING_CREATION" || "PENDING_UPDATE" || "PENDING_DELETION" || "FAILED_CREATION" || "FAILED_UPDATE" || "FAILED_DELETION" || "DELETED",
// AccountId: "STRING_VALUE",
// DomainName: "STRING_VALUE",
// IngressVpcConfiguration: { // IngressVpcConfiguration
// VpcId: "STRING_VALUE",
// VpcEndpointId: "STRING_VALUE",
// },
// CreatedAt: new Date("TIMESTAMP"),
// DeletedAt: new Date("TIMESTAMP"),
// },
// };
CreateVpcIngressConnectionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
IngressVpcConfiguration Required | IngressVpcConfiguration | undefined | 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. |
ServiceArn Required | string | undefined | The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource. |
VpcIngressConnectionName Required | string | undefined | 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. |
Tags | Tag[] | undefined | An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair. |
CreateVpcIngressConnectionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
VpcIngressConnection Required | VpcIngressConnection | undefined | A description of the App Runner VPC Ingress Connection resource that's created by this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServiceErrorException | server | An unexpected service exception occurred. |
InvalidRequestException | client | 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. |
InvalidStateException | client | You can't perform this action when the resource is in its current state. |
ServiceQuotaExceededException | client | App Runner can't create this resource. You've reached your account quota for this resource type. For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference. |
AppRunnerServiceException | Base exception class for all service exceptions from AppRunner service. |