AWS::VpcLattice::TargetGroup - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::VpcLattice::TargetGroup

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::VpcLattice::TargetGroup",
  "Properties" : {
      "Config" : TargetGroupConfig,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "Targets" : [ Target, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::VpcLattice::TargetGroup
Properties:
  Config: 
    TargetGroupConfig
  Name: String
  Tags: 
    - Tag
  Targets: 
    - Target
  Type: String

Properties

Config

The target group configuration.

Required: No

Type: TargetGroupConfig

Update requires: No interruption

Name

The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

Required: No

Type: String

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

Minimum: 3

Maximum: 128

Update requires: Replacement

Tags

The tags for the target group.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Targets

Describes a target.

Required: No

Type: Array of Target

Minimum: 0

Maximum: 100

Update requires: No interruption

Type

The type of target group.

Required: Yes

Type: String

Allowed values: IP | LAMBDA | INSTANCE | ALB

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

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

CreatedAt

The date and time that the target group was created, specified in ISO-8601 format.

Id

The ID of the target group.

LastUpdatedAt

The date and time that the target group was last updated, specified in ISO-8601 format.

Status

The operation's status. You can retry the operation if the status is CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change in the status.