View a markdown version of this page

AWS::Lambda::NetworkConnector - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lambda::NetworkConnector

The AWS::Lambda::NetworkConnector resource creates a network connector that enables Lambda MicroVMs to reach resources in a virtual private cloud (VPC). A network connector provisions elastic network interfaces (ENIs) in the subnets you specify, providing a managed network path to private resources such as databases, caches, and internal APIs.

Syntax

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

JSON

{
  "Type" : "AWS::Lambda::NetworkConnector",
  "Properties" : {
      "Configuration" : Config,
      "Name" : String,
      "OperatorRole" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Lambda::NetworkConnector
Properties:
  Configuration: 
    Config
  Name: String
  OperatorRole: String
  Tags: 
    - Tag

Properties

Configuration

The network configuration for the connector. Specify a VpcEgressConfiguration to enable outbound traffic routing through your VPC.

Required: Yes

Type: Config

Update requires: No interruption

Name

A unique name for the network connector within your account and Region. Must be 1 to 64 alphanumeric characters, hyphens, or underscores.

Required: No

Type: String

Pattern: ^(arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)|[a-zA-Z0-9_-]{1,64}$

Minimum: 1

Maximum: 140

Update requires: Replacement

OperatorRole

The ARN of the IAM role that Lambda assumes to manage elastic network interfaces in your VPC. This role must have permissions for ec2:CreateNetworkInterface and related describe operations.

Required: No

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Minimum: 0

Maximum: 10000

Update requires: No interruption

Tags

A list of tags to apply to the network connector. Use tags to categorize network connectors for cost allocation, access control, or operational management.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the network connector.

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.

Arn

The Amazon Resource Name (ARN) of the network connector.

State

Current state of the network connector. Valid values are PENDING, ACTIVE, INACTIVE, FAILED, DELETING, and DELETE_FAILED.