AWS::VpcLattice::ResourceGateway - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::VpcLattice::ResourceGateway

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

Syntax

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

JSON

{
  "Type" : "AWS::VpcLattice::ResourceGateway",
  "Properties" : {
      "IpAddressType" : String,
      "Name" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "VpcIdentifier" : String
    }
}

YAML

Type: AWS::VpcLattice::ResourceGateway
Properties:
  IpAddressType: String
  Name: String
  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String
  Tags: 
    - Tag
  VpcIdentifier: String

Properties

IpAddressType

The type of IP address used by the resource gateway.

Required: No

Type: String

Allowed values: IPV4 | IPV6 | DUALSTACK

Update requires: Replacement

Name

The name of the resource gateway.

Required: No

Type: String

Pattern: ^(?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Minimum: 3

Maximum: 40

Update requires: Replacement

SecurityGroupIds

The IDs of the security groups applied to the resource gateway.

Required: No

Type: Array of String

Update requires: No interruption

SubnetIds

The IDs of the VPC subnets for the resource gateway.

Required: No

Type: Array of String

Update requires: Replacement

Tags

The tags for the resource gateway.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

VpcIdentifier

The ID of the VPC for the resource gateway.

Required: No

Type: String

Minimum: 5

Maximum: 50

Update requires: Replacement

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

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

Id

The ID of the resource gateway.