AWS::AppRunner::VpcConnector - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::AppRunner::VpcConnector

The AWS::AppRunner::VpcConnector resource is an AWS App Runner resource type that specifies an App Runner VPC connector.

App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

Syntax

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

JSON

{
  "Type" : "AWS::AppRunner::VpcConnector",
  "Properties" : {
      "SecurityGroups" : [ String, ... ],
      "Subnets" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "VpcConnectorName" : String
    }
}

YAML

Type: AWS::AppRunner::VpcConnector
Properties:
  SecurityGroups: 
    - String
  Subnets: 
    - String
  Tags: 
    - Tag
  VpcConnectorName: String

Properties

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.

Required: No

Type: Array of String

Update requires: Replacement

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.

Required: Yes

Type: Array of String

Minimum: 1

Update requires: Replacement

Tags

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

Note

A VpcConnector is immutable, so you cannot update its tags. To change the tags, replace the resource. To replace a VpcConnector, you must provide a new combination of security groups.

Required: No

Type: Array of Tag

Update requires: Replacement

VpcConnectorName

A name for the VPC connector.

If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.

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.

VpcConnectorArn

The Amazon Resource Name (ARN) of this VPC connector.

VpcConnectorRevision

The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

Note

At this time, App Runner supports only one revision per name.

Examples

VPC connector

This example illustrates creating a VPC connector with two subnets and two security groups.

JSON

{
  "Type" : "AWS::AppRunner::VpcConnector",
  "Properties" : {
    "VpcConnectorName": "my-vpc-connector",
    "Subnets": ["subnet-123", "subnet-456"],
    "SecurityGroups": ["sg-123", "sg-456"]
  }
}

YAML

Type: AWS::AppRunner::VpcConnector
Properties:
  VpcConnectorName: my-vpc-connector
  Subnets:
    - subnet-123
    - subnet-456
  SecurityGroups:
    - sg-123
    - sg-456

See also