This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::AppRunner::VpcIngressConnection
<a name="aws-resource-apprunner-vpcingressconnection"></a>

The `AWS::AppRunner::VpcIngressConnection` resource is an AWS 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
<a name="aws-resource-apprunner-vpcingressconnection-syntax"></a>

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

### JSON
<a name="aws-resource-apprunner-vpcingressconnection-syntax.json"></a>

```
{
  "Type" : "AWS::AppRunner::VpcIngressConnection",
  "Properties" : {
      "[IngressVpcConfiguration](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration)" : IngressVpcConfiguration,
      "[ServiceArn](#cfn-apprunner-vpcingressconnection-servicearn)" : String,
      "[Tags](#cfn-apprunner-vpcingressconnection-tags)" : [ Tag, ... ],
      "[VpcIngressConnectionName](#cfn-apprunner-vpcingressconnection-vpcingressconnectionname)" : String
    }
}
```

### YAML
<a name="aws-resource-apprunner-vpcingressconnection-syntax.yaml"></a>

```
Type: AWS::AppRunner::VpcIngressConnection
Properties:
  [IngressVpcConfiguration](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration): 
    IngressVpcConfiguration
  [ServiceArn](#cfn-apprunner-vpcingressconnection-servicearn): String
  [Tags](#cfn-apprunner-vpcingressconnection-tags): 
    - Tag
  [VpcIngressConnectionName](#cfn-apprunner-vpcingressconnection-vpcingressconnectionname): String
```

## Properties
<a name="aws-resource-apprunner-vpcingressconnection-properties"></a>

`IngressVpcConfiguration`  <a name="cfn-apprunner-vpcingressconnection-ingressvpcconfiguration"></a>
Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.  
*Required*: Yes  
*Type*: [IngressVpcConfiguration](aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceArn`  <a name="cfn-apprunner-vpcingressconnection-servicearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-apprunner-vpcingressconnection-tags"></a>
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](aws-properties-apprunner-vpcingressconnection-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcIngressConnectionName`  <a name="cfn-apprunner-vpcingressconnection-vpcingressconnectionname"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-apprunner-vpcingressconnection-return-values"></a>

### Ref
<a name="aws-resource-apprunner-vpcingressconnection-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-apprunner-vpcingressconnection-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-apprunner-vpcingressconnection-return-values-fn--getatt-fn--getatt"></a>

`DomainName`  <a name="DomainName-fn::getatt"></a>
The domain name associated with the VPC Ingress Connection resource.

`Status`  <a name="Status-fn::getatt"></a>
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`  <a name="VpcIngressConnectionArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the VPC Ingress Connection. 

## Examples
<a name="aws-resource-apprunner-vpcingressconnection--examples"></a>

### VPC Ingress Connection
<a name="aws-resource-apprunner-vpcingressconnection--examples--VPC_Ingress_Connection"></a>

This example illustrates creating a VPC Ingress Connection.

#### JSON
<a name="aws-resource-apprunner-vpcingressconnection--examples--VPC_Ingress_Connection--json"></a>

```
{
  "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
<a name="aws-resource-apprunner-vpcingressconnection--examples--VPC_Ingress_Connection--yaml"></a>

```
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
<a name="aws-resource-apprunner-vpcingressconnection--seealso"></a>
+ [Configure network settings for incoming traffic](https://docs.aws.amazon.com/apprunner/latest/dg/network-pl.html) in the *AWS App Runner Developer Guide*

# AWS::AppRunner::VpcIngressConnection IngressVpcConfiguration
<a name="aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration"></a>

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

## Syntax
<a name="aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration-syntax.json"></a>

```
{
  "[VpcEndpointId](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcendpointid)" : String,
  "[VpcId](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcid)" : String
}
```

### YAML
<a name="aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration-syntax.yaml"></a>

```
  [VpcEndpointId](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcendpointid): String
  [VpcId](#cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcid): String
```

## Properties
<a name="aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration-properties"></a>

`VpcEndpointId`  <a name="cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcendpointid"></a>
The ID of the VPC endpoint that your App Runner service connects to.   
*Required*: Yes  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `0`  
*Maximum*: `51200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-apprunner-vpcingressconnection-ingressvpcconfiguration-vpcid"></a>
The ID of the VPC that is used for the VPC endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `0`  
*Maximum*: `51200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::AppRunner::VpcIngressConnection Tag
<a name="aws-properties-apprunner-vpcingressconnection-tag"></a>

Describes a tag that is applied to an AWS App Runner resource. A tag is a metadata item consisting of a key-value pair.

## Syntax
<a name="aws-properties-apprunner-vpcingressconnection-tag-syntax"></a>

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

### JSON
<a name="aws-properties-apprunner-vpcingressconnection-tag-syntax.json"></a>

```
{
  "[Key](#cfn-apprunner-vpcingressconnection-tag-key)" : String,
  "[Value](#cfn-apprunner-vpcingressconnection-tag-value)" : String
}
```

### YAML
<a name="aws-properties-apprunner-vpcingressconnection-tag-syntax.yaml"></a>

```
  [Key](#cfn-apprunner-vpcingressconnection-tag-key): String
  [Value](#cfn-apprunner-vpcingressconnection-tag-value): String
```

## Properties
<a name="aws-properties-apprunner-vpcingressconnection-tag-properties"></a>

`Key`  <a name="cfn-apprunner-vpcingressconnection-tag-key"></a>
The key of the tag.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?!aws:).+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-apprunner-vpcingressconnection-tag-value"></a>
The value of the tag assigned to `VpcIngressConnection` resource of the App Runner service.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)