AWS Fundamentals Logo
AWS Fundamentals
AWS::ElasticLoadBalancingV2::TargetGroup

ElasticLoadBalancingV2 TargetGroup

Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup

Properties

20 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
HealthCheckEnabled
boolean
HealthCheckIntervalSeconds
integer
HealthCheckPath
string
HealthCheckPort
string
HealthCheckProtocol
string
HealthCheckTimeoutSeconds
integer
HealthyThresholdCount
integer
IpAddressType
string
Create-only
Matcher
Matcher
Name
string
Create-only
Port
integer
Create-only
Protocol
string
Create-only
ProtocolVersion
string
Create-only
Tags
Array<Tag>
TargetControlPort
integer
TargetGroupAttributes
Array<TargetGroupAttribute>
Targets
Array<TargetDescription>
TargetType
string
Create-only
UnhealthyThresholdCount
integer
VpcId
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
LoadBalancerArnsArray<string>The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
TargetGroupArnstringThe ARN of the Target Group
TargetGroupFullNamestringThe full name of the target group.
TargetGroupNamestringThe name of the target group.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ElasticLoadBalancingV2::TargetGroup

Resources:
  MyResource:
    Type: AWS::ElasticLoadBalancingV2::TargetGroup
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

elasticloadbalancing:CreateTargetGroupelasticloadbalancing:DescribeTargetGroupselasticloadbalancing:RegisterTargetselasticloadbalancing:ModifyTargetGroupAttributeselasticloadbalancing:DescribeTargetHealthelasticloadbalancing:AddTags

delete

elasticloadbalancing:DeleteTargetGroupelasticloadbalancing:DescribeTargetGroups

list

elasticloadbalancing:DescribeTargetGroups

read

elasticloadbalancing:DescribeTargetGroupselasticloadbalancing:DescribeTargetGroupAttributeselasticloadbalancing:DescribeTargetHealthelasticloadbalancing:DescribeTags

update

elasticloadbalancing:DescribeTargetGroupselasticloadbalancing:ModifyTargetGroupelasticloadbalancing:ModifyTargetGroupAttributeselasticloadbalancing:RegisterTargetselasticloadbalancing:DescribeTargetHealthelasticloadbalancing:DeregisterTargetselasticloadbalancing:AddTagselasticloadbalancing:RemoveTags

Get the ElasticLoadBalancingV2 Cheat Sheet

Everything you need to know about ElasticLoadBalancingV2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceElasticLoadBalancingV2
Properties24
Required0
TaggingSupported
Primary IDTargetGroupArn

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

TargetTypeProtocolVersionPortNameVpcIdProtocolIpAddressType

Related Resources

External Links