AWS::AppRunner::VpcIngressConnection - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AppRunner::VpcIngressConnection

The AWS::AppRunner::VpcIngressConnection resource is an Amazon App Runner resource type that specifies an App Runner VPC Ingress Connection.

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppRunner::VpcIngressConnection",
  "Properties" : {
      "IngressVpcConfiguration" : IngressVpcConfiguration,
      "ServiceArn" : String,
      "Tags" : [ Tag, ... ],
      "VpcIngressConnectionName" : String
    }
}

YAML

Type: AWS::AppRunner::VpcIngressConnection
Properties:
  IngressVpcConfiguration: 
    IngressVpcConfiguration
  ServiceArn: String
  Tags: 
    - Tag
  VpcIngressConnectionName: String

Properties

IngressVpcConfiguration

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

Required: Yes

Type: IngressVpcConfiguration

Update requires: No interruption

ServiceArn

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

Required: Yes

Type: String

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

Minimum: 1

Maximum: 1011

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: Replacement

VpcIngressConnectionName

The customer-provided VPC Ingress Connection name.

Required: No

Type: String

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

Minimum: 4

Maximum: 40

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DomainName

The domain name associated with the VPC Ingress Connection resource.

Status

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

VpcIngressConnectionArn

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

Examples

VPC Ingress Connection

This example illustrates creating a VPC Ingress Connection.

JSON

{
  "Type": "AWS::AppRunner::VpcIngressConnection",
  "Properties": {
    "IngressVpcConfiguration": {
      "VpcEndpointId": "vpc-1a2b3c4d",
      "VpcId": "vpc-4a6b7c8d"
    },
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/my-service",
    "VpcIngressConnectionName": "my-vpc-ingress-connection"
  }
}

YAML

Type: AWS::AppRunner::VpcIngressConnection
Properties:
  IngressVpcConfiguration:
    VpcEndpointId: vpce-1a2b3c4d
    VpcId: vpc-4a6b7c8d
  ServiceArn: arn:aws:apprunner:us-east-1:123456789012:service/my-service
  VpcIngressConnectionName: my-vpc-ingress-connection

See also