aws.alb.TargetGroup
Explore with Pulumi AI
Provides a Target Group resource for use with Load Balancer resources.
Note:
aws.alb.TargetGroup
is known asaws.lb.TargetGroup
. The functionality is identical.
Example Usage
Instance Target Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = new aws.ec2.Vpc("main", {cidrBlock: "10.0.0.0/16"});
const test = new aws.lb.TargetGroup("test", {
name: "tf-example-lb-tg",
port: 80,
protocol: "HTTP",
vpcId: main.id,
});
import pulumi
import pulumi_aws as aws
main = aws.ec2.Vpc("main", cidr_block="10.0.0.0/16")
test = aws.lb.TargetGroup("test",
name="tf-example-lb-tg",
port=80,
protocol="HTTP",
vpc_id=main.id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
main, err := ec2.NewVpc(ctx, "main", &ec2.VpcArgs{
CidrBlock: pulumi.String("10.0.0.0/16"),
})
if err != nil {
return err
}
_, err = lb.NewTargetGroup(ctx, "test", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-tg"),
Port: pulumi.Int(80),
Protocol: pulumi.String("HTTP"),
VpcId: main.ID(),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var main = new Aws.Ec2.Vpc("main", new()
{
CidrBlock = "10.0.0.0/16",
});
var test = new Aws.LB.TargetGroup("test", new()
{
Name = "tf-example-lb-tg",
Port = 80,
Protocol = "HTTP",
VpcId = main.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var main = new Vpc("main", VpcArgs.builder()
.cidrBlock("10.0.0.0/16")
.build());
var test = new TargetGroup("test", TargetGroupArgs.builder()
.name("tf-example-lb-tg")
.port(80)
.protocol("HTTP")
.vpcId(main.id())
.build());
}
}
resources:
test:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-tg
port: 80
protocol: HTTP
vpcId: ${main.id}
main:
type: aws:ec2:Vpc
properties:
cidrBlock: 10.0.0.0/16
IP Target Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = new aws.ec2.Vpc("main", {cidrBlock: "10.0.0.0/16"});
const ip_example = new aws.lb.TargetGroup("ip-example", {
name: "tf-example-lb-tg",
port: 80,
protocol: "HTTP",
targetType: "ip",
vpcId: main.id,
});
import pulumi
import pulumi_aws as aws
main = aws.ec2.Vpc("main", cidr_block="10.0.0.0/16")
ip_example = aws.lb.TargetGroup("ip-example",
name="tf-example-lb-tg",
port=80,
protocol="HTTP",
target_type="ip",
vpc_id=main.id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
main, err := ec2.NewVpc(ctx, "main", &ec2.VpcArgs{
CidrBlock: pulumi.String("10.0.0.0/16"),
})
if err != nil {
return err
}
_, err = lb.NewTargetGroup(ctx, "ip-example", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-tg"),
Port: pulumi.Int(80),
Protocol: pulumi.String("HTTP"),
TargetType: pulumi.String("ip"),
VpcId: main.ID(),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var main = new Aws.Ec2.Vpc("main", new()
{
CidrBlock = "10.0.0.0/16",
});
var ip_example = new Aws.LB.TargetGroup("ip-example", new()
{
Name = "tf-example-lb-tg",
Port = 80,
Protocol = "HTTP",
TargetType = "ip",
VpcId = main.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var main = new Vpc("main", VpcArgs.builder()
.cidrBlock("10.0.0.0/16")
.build());
var ip_example = new TargetGroup("ip-example", TargetGroupArgs.builder()
.name("tf-example-lb-tg")
.port(80)
.protocol("HTTP")
.targetType("ip")
.vpcId(main.id())
.build());
}
}
resources:
ip-example:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-tg
port: 80
protocol: HTTP
targetType: ip
vpcId: ${main.id}
main:
type: aws:ec2:Vpc
properties:
cidrBlock: 10.0.0.0/16
Lambda Target Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const lambda_example = new aws.lb.TargetGroup("lambda-example", {
name: "tf-example-lb-tg",
targetType: "lambda",
});
import pulumi
import pulumi_aws as aws
lambda_example = aws.lb.TargetGroup("lambda-example",
name="tf-example-lb-tg",
target_type="lambda")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewTargetGroup(ctx, "lambda-example", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-tg"),
TargetType: pulumi.String("lambda"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var lambda_example = new Aws.LB.TargetGroup("lambda-example", new()
{
Name = "tf-example-lb-tg",
TargetType = "lambda",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var lambda_example = new TargetGroup("lambda-example", TargetGroupArgs.builder()
.name("tf-example-lb-tg")
.targetType("lambda")
.build());
}
}
resources:
lambda-example:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-tg
targetType: lambda
ALB Target Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const alb_example = new aws.lb.TargetGroup("alb-example", {
name: "tf-example-lb-alb-tg",
targetType: "alb",
port: 80,
protocol: "TCP",
vpcId: main.id,
});
import pulumi
import pulumi_aws as aws
alb_example = aws.lb.TargetGroup("alb-example",
name="tf-example-lb-alb-tg",
target_type="alb",
port=80,
protocol="TCP",
vpc_id=main["id"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewTargetGroup(ctx, "alb-example", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-alb-tg"),
TargetType: pulumi.String("alb"),
Port: pulumi.Int(80),
Protocol: pulumi.String("TCP"),
VpcId: pulumi.Any(main.Id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var alb_example = new Aws.LB.TargetGroup("alb-example", new()
{
Name = "tf-example-lb-alb-tg",
TargetType = "alb",
Port = 80,
Protocol = "TCP",
VpcId = main.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var alb_example = new TargetGroup("alb-example", TargetGroupArgs.builder()
.name("tf-example-lb-alb-tg")
.targetType("alb")
.port(80)
.protocol("TCP")
.vpcId(main.id())
.build());
}
}
resources:
alb-example:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-alb-tg
targetType: alb
port: 80
protocol: TCP
vpcId: ${main.id}
Target group with unhealthy connection termination disabled
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const tcp_example = new aws.lb.TargetGroup("tcp-example", {
name: "tf-example-lb-nlb-tg",
port: 25,
protocol: "TCP",
vpcId: main.id,
targetHealthStates: [{
enableUnhealthyConnectionTermination: false,
}],
});
import pulumi
import pulumi_aws as aws
tcp_example = aws.lb.TargetGroup("tcp-example",
name="tf-example-lb-nlb-tg",
port=25,
protocol="TCP",
vpc_id=main["id"],
target_health_states=[{
"enable_unhealthy_connection_termination": False,
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewTargetGroup(ctx, "tcp-example", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-nlb-tg"),
Port: pulumi.Int(25),
Protocol: pulumi.String("TCP"),
VpcId: pulumi.Any(main.Id),
TargetHealthStates: lb.TargetGroupTargetHealthStateArray{
&lb.TargetGroupTargetHealthStateArgs{
EnableUnhealthyConnectionTermination: pulumi.Bool(false),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var tcp_example = new Aws.LB.TargetGroup("tcp-example", new()
{
Name = "tf-example-lb-nlb-tg",
Port = 25,
Protocol = "TCP",
VpcId = main.Id,
TargetHealthStates = new[]
{
new Aws.LB.Inputs.TargetGroupTargetHealthStateArgs
{
EnableUnhealthyConnectionTermination = false,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import com.pulumi.aws.lb.inputs.TargetGroupTargetHealthStateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var tcp_example = new TargetGroup("tcp-example", TargetGroupArgs.builder()
.name("tf-example-lb-nlb-tg")
.port(25)
.protocol("TCP")
.vpcId(main.id())
.targetHealthStates(TargetGroupTargetHealthStateArgs.builder()
.enableUnhealthyConnectionTermination(false)
.build())
.build());
}
}
resources:
tcp-example:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-nlb-tg
port: 25
protocol: TCP
vpcId: ${main.id}
targetHealthStates:
- enableUnhealthyConnectionTermination: false
Target group with health requirements
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const tcp_example = new aws.lb.TargetGroup("tcp-example", {
name: "tf-example-lb-nlb-tg",
port: 80,
protocol: "TCP",
vpcId: main.id,
targetGroupHealth: {
dnsFailover: {
minimumHealthyTargetsCount: "1",
minimumHealthyTargetsPercentage: "off",
},
unhealthyStateRouting: {
minimumHealthyTargetsCount: 1,
minimumHealthyTargetsPercentage: "off",
},
},
});
import pulumi
import pulumi_aws as aws
tcp_example = aws.lb.TargetGroup("tcp-example",
name="tf-example-lb-nlb-tg",
port=80,
protocol="TCP",
vpc_id=main["id"],
target_group_health={
"dns_failover": {
"minimum_healthy_targets_count": "1",
"minimum_healthy_targets_percentage": "off",
},
"unhealthy_state_routing": {
"minimum_healthy_targets_count": 1,
"minimum_healthy_targets_percentage": "off",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewTargetGroup(ctx, "tcp-example", &lb.TargetGroupArgs{
Name: pulumi.String("tf-example-lb-nlb-tg"),
Port: pulumi.Int(80),
Protocol: pulumi.String("TCP"),
VpcId: pulumi.Any(main.Id),
TargetGroupHealth: &lb.TargetGroupTargetGroupHealthArgs{
DnsFailover: &lb.TargetGroupTargetGroupHealthDnsFailoverArgs{
MinimumHealthyTargetsCount: pulumi.String("1"),
MinimumHealthyTargetsPercentage: pulumi.String("off"),
},
UnhealthyStateRouting: &lb.TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs{
MinimumHealthyTargetsCount: pulumi.Int(1),
MinimumHealthyTargetsPercentage: pulumi.String("off"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var tcp_example = new Aws.LB.TargetGroup("tcp-example", new()
{
Name = "tf-example-lb-nlb-tg",
Port = 80,
Protocol = "TCP",
VpcId = main.Id,
TargetGroupHealth = new Aws.LB.Inputs.TargetGroupTargetGroupHealthArgs
{
DnsFailover = new Aws.LB.Inputs.TargetGroupTargetGroupHealthDnsFailoverArgs
{
MinimumHealthyTargetsCount = "1",
MinimumHealthyTargetsPercentage = "off",
},
UnhealthyStateRouting = new Aws.LB.Inputs.TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs
{
MinimumHealthyTargetsCount = 1,
MinimumHealthyTargetsPercentage = "off",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.TargetGroup;
import com.pulumi.aws.lb.TargetGroupArgs;
import com.pulumi.aws.lb.inputs.TargetGroupTargetGroupHealthArgs;
import com.pulumi.aws.lb.inputs.TargetGroupTargetGroupHealthDnsFailoverArgs;
import com.pulumi.aws.lb.inputs.TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var tcp_example = new TargetGroup("tcp-example", TargetGroupArgs.builder()
.name("tf-example-lb-nlb-tg")
.port(80)
.protocol("TCP")
.vpcId(main.id())
.targetGroupHealth(TargetGroupTargetGroupHealthArgs.builder()
.dnsFailover(TargetGroupTargetGroupHealthDnsFailoverArgs.builder()
.minimumHealthyTargetsCount("1")
.minimumHealthyTargetsPercentage("off")
.build())
.unhealthyStateRouting(TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs.builder()
.minimumHealthyTargetsCount("1")
.minimumHealthyTargetsPercentage("off")
.build())
.build())
.build());
}
}
resources:
tcp-example:
type: aws:lb:TargetGroup
properties:
name: tf-example-lb-nlb-tg
port: 80
protocol: TCP
vpcId: ${main.id}
targetGroupHealth:
dnsFailover:
minimumHealthyTargetsCount: '1'
minimumHealthyTargetsPercentage: off
unhealthyStateRouting:
minimumHealthyTargetsCount: '1'
minimumHealthyTargetsPercentage: off
Create TargetGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TargetGroup(name: string, args?: TargetGroupArgs, opts?: CustomResourceOptions);
@overload
def TargetGroup(resource_name: str,
args: Optional[TargetGroupArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TargetGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_termination: Optional[bool] = None,
deregistration_delay: Optional[int] = None,
health_check: Optional[TargetGroupHealthCheckArgs] = None,
ip_address_type: Optional[str] = None,
lambda_multi_value_headers_enabled: Optional[bool] = None,
load_balancing_algorithm_type: Optional[str] = None,
load_balancing_anomaly_mitigation: Optional[str] = None,
load_balancing_cross_zone_enabled: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
port: Optional[int] = None,
preserve_client_ip: Optional[str] = None,
protocol: Optional[str] = None,
protocol_version: Optional[str] = None,
proxy_protocol_v2: Optional[bool] = None,
slow_start: Optional[int] = None,
stickiness: Optional[TargetGroupStickinessArgs] = None,
tags: Optional[Mapping[str, str]] = None,
target_failovers: Optional[Sequence[TargetGroupTargetFailoverArgs]] = None,
target_group_health: Optional[TargetGroupTargetGroupHealthArgs] = None,
target_health_states: Optional[Sequence[TargetGroupTargetHealthStateArgs]] = None,
target_type: Optional[str] = None,
vpc_id: Optional[str] = None)
func NewTargetGroup(ctx *Context, name string, args *TargetGroupArgs, opts ...ResourceOption) (*TargetGroup, error)
public TargetGroup(string name, TargetGroupArgs? args = null, CustomResourceOptions? opts = null)
public TargetGroup(String name, TargetGroupArgs args)
public TargetGroup(String name, TargetGroupArgs args, CustomResourceOptions options)
type: aws:alb:TargetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TargetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TargetGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TargetGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TargetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TargetGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var targetGroupResource = new Aws.Alb.TargetGroup("targetGroupResource", new()
{
ConnectionTermination = false,
DeregistrationDelay = 0,
HealthCheck = new Aws.Alb.Inputs.TargetGroupHealthCheckArgs
{
Enabled = false,
HealthyThreshold = 0,
Interval = 0,
Matcher = "string",
Path = "string",
Port = "string",
Protocol = "string",
Timeout = 0,
UnhealthyThreshold = 0,
},
IpAddressType = "string",
LambdaMultiValueHeadersEnabled = false,
LoadBalancingAlgorithmType = "string",
LoadBalancingAnomalyMitigation = "string",
LoadBalancingCrossZoneEnabled = "string",
Name = "string",
NamePrefix = "string",
Port = 0,
PreserveClientIp = "string",
Protocol = "string",
ProtocolVersion = "string",
ProxyProtocolV2 = false,
SlowStart = 0,
Stickiness = new Aws.Alb.Inputs.TargetGroupStickinessArgs
{
Type = "string",
CookieDuration = 0,
CookieName = "string",
Enabled = false,
},
Tags =
{
{ "string", "string" },
},
TargetFailovers = new[]
{
new Aws.Alb.Inputs.TargetGroupTargetFailoverArgs
{
OnDeregistration = "string",
OnUnhealthy = "string",
},
},
TargetGroupHealth = new Aws.Alb.Inputs.TargetGroupTargetGroupHealthArgs
{
DnsFailover = new Aws.Alb.Inputs.TargetGroupTargetGroupHealthDnsFailoverArgs
{
MinimumHealthyTargetsCount = "string",
MinimumHealthyTargetsPercentage = "string",
},
UnhealthyStateRouting = new Aws.Alb.Inputs.TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs
{
MinimumHealthyTargetsCount = 0,
MinimumHealthyTargetsPercentage = "string",
},
},
TargetHealthStates = new[]
{
new Aws.Alb.Inputs.TargetGroupTargetHealthStateArgs
{
EnableUnhealthyConnectionTermination = false,
UnhealthyDrainingInterval = 0,
},
},
TargetType = "string",
VpcId = "string",
});
example, err := alb.NewTargetGroup(ctx, "targetGroupResource", &alb.TargetGroupArgs{
ConnectionTermination: pulumi.Bool(false),
DeregistrationDelay: pulumi.Int(0),
HealthCheck: &alb.TargetGroupHealthCheckArgs{
Enabled: pulumi.Bool(false),
HealthyThreshold: pulumi.Int(0),
Interval: pulumi.Int(0),
Matcher: pulumi.String("string"),
Path: pulumi.String("string"),
Port: pulumi.String("string"),
Protocol: pulumi.String("string"),
Timeout: pulumi.Int(0),
UnhealthyThreshold: pulumi.Int(0),
},
IpAddressType: pulumi.String("string"),
LambdaMultiValueHeadersEnabled: pulumi.Bool(false),
LoadBalancingAlgorithmType: pulumi.String("string"),
LoadBalancingAnomalyMitigation: pulumi.String("string"),
LoadBalancingCrossZoneEnabled: pulumi.String("string"),
Name: pulumi.String("string"),
NamePrefix: pulumi.String("string"),
Port: pulumi.Int(0),
PreserveClientIp: pulumi.String("string"),
Protocol: pulumi.String("string"),
ProtocolVersion: pulumi.String("string"),
ProxyProtocolV2: pulumi.Bool(false),
SlowStart: pulumi.Int(0),
Stickiness: &alb.TargetGroupStickinessArgs{
Type: pulumi.String("string"),
CookieDuration: pulumi.Int(0),
CookieName: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TargetFailovers: alb.TargetGroupTargetFailoverArray{
&alb.TargetGroupTargetFailoverArgs{
OnDeregistration: pulumi.String("string"),
OnUnhealthy: pulumi.String("string"),
},
},
TargetGroupHealth: &alb.TargetGroupTargetGroupHealthArgs{
DnsFailover: &alb.TargetGroupTargetGroupHealthDnsFailoverArgs{
MinimumHealthyTargetsCount: pulumi.String("string"),
MinimumHealthyTargetsPercentage: pulumi.String("string"),
},
UnhealthyStateRouting: &alb.TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs{
MinimumHealthyTargetsCount: pulumi.Int(0),
MinimumHealthyTargetsPercentage: pulumi.String("string"),
},
},
TargetHealthStates: alb.TargetGroupTargetHealthStateArray{
&alb.TargetGroupTargetHealthStateArgs{
EnableUnhealthyConnectionTermination: pulumi.Bool(false),
UnhealthyDrainingInterval: pulumi.Int(0),
},
},
TargetType: pulumi.String("string"),
VpcId: pulumi.String("string"),
})
var targetGroupResource = new TargetGroup("targetGroupResource", TargetGroupArgs.builder()
.connectionTermination(false)
.deregistrationDelay(0)
.healthCheck(TargetGroupHealthCheckArgs.builder()
.enabled(false)
.healthyThreshold(0)
.interval(0)
.matcher("string")
.path("string")
.port("string")
.protocol("string")
.timeout(0)
.unhealthyThreshold(0)
.build())
.ipAddressType("string")
.lambdaMultiValueHeadersEnabled(false)
.loadBalancingAlgorithmType("string")
.loadBalancingAnomalyMitigation("string")
.loadBalancingCrossZoneEnabled("string")
.name("string")
.namePrefix("string")
.port(0)
.preserveClientIp("string")
.protocol("string")
.protocolVersion("string")
.proxyProtocolV2(false)
.slowStart(0)
.stickiness(TargetGroupStickinessArgs.builder()
.type("string")
.cookieDuration(0)
.cookieName("string")
.enabled(false)
.build())
.tags(Map.of("string", "string"))
.targetFailovers(TargetGroupTargetFailoverArgs.builder()
.onDeregistration("string")
.onUnhealthy("string")
.build())
.targetGroupHealth(TargetGroupTargetGroupHealthArgs.builder()
.dnsFailover(TargetGroupTargetGroupHealthDnsFailoverArgs.builder()
.minimumHealthyTargetsCount("string")
.minimumHealthyTargetsPercentage("string")
.build())
.unhealthyStateRouting(TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs.builder()
.minimumHealthyTargetsCount(0)
.minimumHealthyTargetsPercentage("string")
.build())
.build())
.targetHealthStates(TargetGroupTargetHealthStateArgs.builder()
.enableUnhealthyConnectionTermination(false)
.unhealthyDrainingInterval(0)
.build())
.targetType("string")
.vpcId("string")
.build());
target_group_resource = aws.alb.TargetGroup("targetGroupResource",
connection_termination=False,
deregistration_delay=0,
health_check={
"enabled": False,
"healthy_threshold": 0,
"interval": 0,
"matcher": "string",
"path": "string",
"port": "string",
"protocol": "string",
"timeout": 0,
"unhealthy_threshold": 0,
},
ip_address_type="string",
lambda_multi_value_headers_enabled=False,
load_balancing_algorithm_type="string",
load_balancing_anomaly_mitigation="string",
load_balancing_cross_zone_enabled="string",
name="string",
name_prefix="string",
port=0,
preserve_client_ip="string",
protocol="string",
protocol_version="string",
proxy_protocol_v2=False,
slow_start=0,
stickiness={
"type": "string",
"cookie_duration": 0,
"cookie_name": "string",
"enabled": False,
},
tags={
"string": "string",
},
target_failovers=[{
"on_deregistration": "string",
"on_unhealthy": "string",
}],
target_group_health={
"dns_failover": {
"minimum_healthy_targets_count": "string",
"minimum_healthy_targets_percentage": "string",
},
"unhealthy_state_routing": {
"minimum_healthy_targets_count": 0,
"minimum_healthy_targets_percentage": "string",
},
},
target_health_states=[{
"enable_unhealthy_connection_termination": False,
"unhealthy_draining_interval": 0,
}],
target_type="string",
vpc_id="string")
const targetGroupResource = new aws.alb.TargetGroup("targetGroupResource", {
connectionTermination: false,
deregistrationDelay: 0,
healthCheck: {
enabled: false,
healthyThreshold: 0,
interval: 0,
matcher: "string",
path: "string",
port: "string",
protocol: "string",
timeout: 0,
unhealthyThreshold: 0,
},
ipAddressType: "string",
lambdaMultiValueHeadersEnabled: false,
loadBalancingAlgorithmType: "string",
loadBalancingAnomalyMitigation: "string",
loadBalancingCrossZoneEnabled: "string",
name: "string",
namePrefix: "string",
port: 0,
preserveClientIp: "string",
protocol: "string",
protocolVersion: "string",
proxyProtocolV2: false,
slowStart: 0,
stickiness: {
type: "string",
cookieDuration: 0,
cookieName: "string",
enabled: false,
},
tags: {
string: "string",
},
targetFailovers: [{
onDeregistration: "string",
onUnhealthy: "string",
}],
targetGroupHealth: {
dnsFailover: {
minimumHealthyTargetsCount: "string",
minimumHealthyTargetsPercentage: "string",
},
unhealthyStateRouting: {
minimumHealthyTargetsCount: 0,
minimumHealthyTargetsPercentage: "string",
},
},
targetHealthStates: [{
enableUnhealthyConnectionTermination: false,
unhealthyDrainingInterval: 0,
}],
targetType: "string",
vpcId: "string",
});
type: aws:alb:TargetGroup
properties:
connectionTermination: false
deregistrationDelay: 0
healthCheck:
enabled: false
healthyThreshold: 0
interval: 0
matcher: string
path: string
port: string
protocol: string
timeout: 0
unhealthyThreshold: 0
ipAddressType: string
lambdaMultiValueHeadersEnabled: false
loadBalancingAlgorithmType: string
loadBalancingAnomalyMitigation: string
loadBalancingCrossZoneEnabled: string
name: string
namePrefix: string
port: 0
preserveClientIp: string
protocol: string
protocolVersion: string
proxyProtocolV2: false
slowStart: 0
stickiness:
cookieDuration: 0
cookieName: string
enabled: false
type: string
tags:
string: string
targetFailovers:
- onDeregistration: string
onUnhealthy: string
targetGroupHealth:
dnsFailover:
minimumHealthyTargetsCount: string
minimumHealthyTargetsPercentage: string
unhealthyStateRouting:
minimumHealthyTargetsCount: 0
minimumHealthyTargetsPercentage: string
targetHealthStates:
- enableUnhealthyConnectionTermination: false
unhealthyDrainingInterval: 0
targetType: string
vpcId: string
TargetGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TargetGroup resource accepts the following input properties:
- Connection
Termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - Deregistration
Delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- Health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- Ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - Lambda
Multi boolValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - Load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - Load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - Load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - Name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - Port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - Preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- Protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - Protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - Proxy
Protocol boolV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - Slow
Start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- Stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- Dictionary<string, string>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Target
Failovers List<TargetGroup Target Failover> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- Target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- Target
Health List<TargetStates Group Target Health State> - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - Target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- Vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- Connection
Termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - Deregistration
Delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- Health
Check TargetGroup Health Check Args - Health Check configuration block. Detailed below.
- Ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - Lambda
Multi boolValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - Load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - Load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - Load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - Name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - Port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - Preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- Protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - Protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - Proxy
Protocol boolV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - Slow
Start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- Stickiness
Target
Group Stickiness Args - Stickiness configuration block. Detailed below.
- map[string]string
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Target
Failovers []TargetGroup Target Failover Args - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- Target
Group TargetHealth Group Target Group Health Args - Target health requirements block. See target_group_health for more information.
- Target
Health []TargetStates Group Target Health State Args - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - Target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- Vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- connection
Termination Boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay Integer - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- ip
Address StringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi BooleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancing StringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing StringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing StringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name String
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port Integer
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client StringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol String
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version String - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol BooleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start Integer - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- Map<String,String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - target
Failovers List<TargetGroup Target Failover> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- target
Health List<TargetStates Group Target Health State> - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type String Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id String - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- connection
Termination boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay number - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi booleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port number
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol booleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start number - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- {[key: string]: string}
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - target
Failovers TargetGroup Target Failover[] - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- target
Health TargetStates Group Target Health State[] - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- connection_
termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration_
delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health_
check TargetGroup Health Check Args - Health Check configuration block. Detailed below.
- ip_
address_ strtype - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda_
multi_ boolvalue_ headers_ enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load_
balancing_ stralgorithm_ type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load_
balancing_ stranomaly_ mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load_
balancing_ strcross_ zone_ enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name str
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve_
client_ strip - Whether client IP preservation is enabled. See doc for more information.
- protocol str
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol_
version str - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy_
protocol_ boolv2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow_
start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness Args - Stickiness configuration block. Detailed below.
- Mapping[str, str]
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - target_
failovers Sequence[TargetGroup Target Failover Args] - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target_
group_ Targethealth Group Target Group Health Args - Target health requirements block. See target_group_health for more information.
- target_
health_ Sequence[Targetstates Group Target Health State Args] - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target_
type str Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc_
id str - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- connection
Termination Boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay Number - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check Property Map - Health Check configuration block. Detailed below.
- ip
Address StringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi BooleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancing StringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing StringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing StringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name String
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port Number
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client StringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol String
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version String - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol BooleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start Number - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness Property Map
- Stickiness configuration block. Detailed below.
- Map<String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - target
Failovers List<Property Map> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group Property MapHealth - Target health requirements block. See target_group_health for more information.
- target
Health List<Property Map>States - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type String Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id String - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
Outputs
All input properties are implicitly available as output properties. Additionally, the TargetGroup resource produces the following output properties:
- Arn string
- ARN of the Target Group (matches
id
). - Arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer List<string>Arns - ARNs of the Load Balancers associated with the Target Group.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- ARN of the Target Group (matches
id
). - Arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer []stringArns - ARNs of the Load Balancers associated with the Target Group.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- ARN of the Target Group (matches
id
). - arn
Suffix String - ARN suffix for use with CloudWatch Metrics.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer List<String>Arns - ARNs of the Load Balancers associated with the Target Group.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- ARN of the Target Group (matches
id
). - arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- id string
- The provider-assigned unique ID for this managed resource.
- load
Balancer string[]Arns - ARNs of the Load Balancers associated with the Target Group.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- ARN of the Target Group (matches
id
). - arn_
suffix str - ARN suffix for use with CloudWatch Metrics.
- id str
- The provider-assigned unique ID for this managed resource.
- load_
balancer_ Sequence[str]arns - ARNs of the Load Balancers associated with the Target Group.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- ARN of the Target Group (matches
id
). - arn
Suffix String - ARN suffix for use with CloudWatch Metrics.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer List<String>Arns - ARNs of the Load Balancers associated with the Target Group.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing TargetGroup Resource
Get an existing TargetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TargetGroupState, opts?: CustomResourceOptions): TargetGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
arn_suffix: Optional[str] = None,
connection_termination: Optional[bool] = None,
deregistration_delay: Optional[int] = None,
health_check: Optional[TargetGroupHealthCheckArgs] = None,
ip_address_type: Optional[str] = None,
lambda_multi_value_headers_enabled: Optional[bool] = None,
load_balancer_arns: Optional[Sequence[str]] = None,
load_balancing_algorithm_type: Optional[str] = None,
load_balancing_anomaly_mitigation: Optional[str] = None,
load_balancing_cross_zone_enabled: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
port: Optional[int] = None,
preserve_client_ip: Optional[str] = None,
protocol: Optional[str] = None,
protocol_version: Optional[str] = None,
proxy_protocol_v2: Optional[bool] = None,
slow_start: Optional[int] = None,
stickiness: Optional[TargetGroupStickinessArgs] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
target_failovers: Optional[Sequence[TargetGroupTargetFailoverArgs]] = None,
target_group_health: Optional[TargetGroupTargetGroupHealthArgs] = None,
target_health_states: Optional[Sequence[TargetGroupTargetHealthStateArgs]] = None,
target_type: Optional[str] = None,
vpc_id: Optional[str] = None) -> TargetGroup
func GetTargetGroup(ctx *Context, name string, id IDInput, state *TargetGroupState, opts ...ResourceOption) (*TargetGroup, error)
public static TargetGroup Get(string name, Input<string> id, TargetGroupState? state, CustomResourceOptions? opts = null)
public static TargetGroup get(String name, Output<String> id, TargetGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the Target Group (matches
id
). - Arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- Connection
Termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - Deregistration
Delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- Health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- Ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - Lambda
Multi boolValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - Load
Balancer List<string>Arns - ARNs of the Load Balancers associated with the Target Group.
- Load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - Load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - Load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - Name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - Port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - Preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- Protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - Protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - Proxy
Protocol boolV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - Slow
Start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- Stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- Dictionary<string, string>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Target
Failovers List<TargetGroup Target Failover> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- Target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- Target
Health List<TargetStates Group Target Health State> - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - Target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- Vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- Arn string
- ARN of the Target Group (matches
id
). - Arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- Connection
Termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - Deregistration
Delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- Health
Check TargetGroup Health Check Args - Health Check configuration block. Detailed below.
- Ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - Lambda
Multi boolValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - Load
Balancer []stringArns - ARNs of the Load Balancers associated with the Target Group.
- Load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - Load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - Load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - Name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - Port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - Preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- Protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - Protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - Proxy
Protocol boolV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - Slow
Start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- Stickiness
Target
Group Stickiness Args - Stickiness configuration block. Detailed below.
- map[string]string
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Target
Failovers []TargetGroup Target Failover Args - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- Target
Group TargetHealth Group Target Group Health Args - Target health requirements block. See target_group_health for more information.
- Target
Health []TargetStates Group Target Health State Args - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - Target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- Vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- arn String
- ARN of the Target Group (matches
id
). - arn
Suffix String - ARN suffix for use with CloudWatch Metrics.
- connection
Termination Boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay Integer - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- ip
Address StringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi BooleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancer List<String>Arns - ARNs of the Load Balancers associated with the Target Group.
- load
Balancing StringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing StringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing StringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name String
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port Integer
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client StringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol String
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version String - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol BooleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start Integer - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- Map<String,String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - target
Failovers List<TargetGroup Target Failover> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- target
Health List<TargetStates Group Target Health State> - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type String Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id String - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- arn string
- ARN of the Target Group (matches
id
). - arn
Suffix string - ARN suffix for use with CloudWatch Metrics.
- connection
Termination boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay number - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check TargetGroup Health Check - Health Check configuration block. Detailed below.
- ip
Address stringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi booleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancer string[]Arns - ARNs of the Load Balancers associated with the Target Group.
- load
Balancing stringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing stringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing stringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name string
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port number
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client stringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol string
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version string - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol booleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start number - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness - Stickiness configuration block. Detailed below.
- {[key: string]: string}
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - target
Failovers TargetGroup Target Failover[] - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group TargetHealth Group Target Group Health - Target health requirements block. See target_group_health for more information.
- target
Health TargetStates Group Target Health State[] - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type string Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id string - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- arn str
- ARN of the Target Group (matches
id
). - arn_
suffix str - ARN suffix for use with CloudWatch Metrics.
- connection_
termination bool - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration_
delay int - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health_
check TargetGroup Health Check Args - Health Check configuration block. Detailed below.
- ip_
address_ strtype - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda_
multi_ boolvalue_ headers_ enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load_
balancer_ Sequence[str]arns - ARNs of the Load Balancers associated with the Target Group.
- load_
balancing_ stralgorithm_ type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load_
balancing_ stranomaly_ mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load_
balancing_ strcross_ zone_ enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name str
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port int
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve_
client_ strip - Whether client IP preservation is enabled. See doc for more information.
- protocol str
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol_
version str - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy_
protocol_ boolv2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow_
start int - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness
Target
Group Stickiness Args - Stickiness configuration block. Detailed below.
- Mapping[str, str]
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - target_
failovers Sequence[TargetGroup Target Failover Args] - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target_
group_ Targethealth Group Target Group Health Args - Target health requirements block. See target_group_health for more information.
- target_
health_ Sequence[Targetstates Group Target Health State Args] - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target_
type str Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc_
id str - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
- arn String
- ARN of the Target Group (matches
id
). - arn
Suffix String - ARN suffix for use with CloudWatch Metrics.
- connection
Termination Boolean - Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See doc for more information. Default is
false
. - deregistration
Delay Number - Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.
- health
Check Property Map - Health Check configuration block. Detailed below.
- ip
Address StringType - The type of IP addresses used by the target group, only supported when target type is set to
ip
. Possible values areipv4
oripv6
. - lambda
Multi BooleanValue Headers Enabled - Whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. Only applies when
target_type
islambda
. Default isfalse
. - load
Balancer List<String>Arns - ARNs of the Load Balancers associated with the Target Group.
- load
Balancing StringAlgorithm Type - Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is
round_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. - load
Balancing StringAnomaly Mitigation - Determines whether to enable target anomaly mitigation. Target anomaly mitigation is only supported by the
weighted_random
load balancing algorithm type. See doc for more information. The value is"on"
or"off"
. The default is"off"
. - load
Balancing StringCross Zone Enabled - Indicates whether cross zone load balancing is enabled. The value is
"true"
,"false"
or"use_load_balancer_configuration"
. The default is"use_load_balancer_configuration"
. - name String
- Name of the target group. If omitted, this provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. Cannot be longer than 6 characters. - port Number
- Port on which targets receive traffic, unless overridden when registering a specific target. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
. - preserve
Client StringIp - Whether client IP preservation is enabled. See doc for more information.
- protocol String
- Protocol to use for routing traffic to the targets.
Should be one of
GENEVE
,HTTP
,HTTPS
,TCP
,TCP_UDP
,TLS
, orUDP
. Required whentarget_type
isinstance
,ip
, oralb
. Does not apply whentarget_type
islambda
. - protocol
Version String - Only applicable when
protocol
isHTTP
orHTTPS
. The protocol version. SpecifyGRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1 - proxy
Protocol BooleanV2 - Whether to enable support for proxy protocol v2 on Network Load Balancers. See doc for more information. Default is
false
. - slow
Start Number - Amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds.
- stickiness Property Map
- Stickiness configuration block. Detailed below.
- Map<String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - target
Failovers List<Property Map> - Target failover block. Only applicable for Gateway Load Balancer target groups. See target_failover for more information.
- target
Group Property MapHealth - Target health requirements block. See target_group_health for more information.
- target
Health List<Property Map>States - Target health state block. Only applicable for Network Load Balancer target groups when
protocol
isTCP
orTLS
. See target_health_state for more information. - target
Type String Type of target that you must specify when registering targets with this target group. See doc for supported values. The default is
instance
.Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is
ip
, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.Network Load Balancers do not support the
lambda
target type.Application Load Balancers do not support the
alb
target type.- vpc
Id String - Identifier of the VPC in which to create the target group. Required when
target_type
isinstance
,ip
oralb
. Does not apply whentarget_type
islambda
.
Supporting Types
TargetGroupHealthCheck, TargetGroupHealthCheckArgs
- Enabled bool
- Whether health checks are enabled. Defaults to
true
. - Healthy
Threshold int - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- Interval int
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - Matcher string
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- Path string
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- Port string
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - Protocol string
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - Timeout int
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- Unhealthy
Threshold int - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
- Enabled bool
- Whether health checks are enabled. Defaults to
true
. - Healthy
Threshold int - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- Interval int
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - Matcher string
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- Path string
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- Port string
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - Protocol string
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - Timeout int
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- Unhealthy
Threshold int - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
- enabled Boolean
- Whether health checks are enabled. Defaults to
true
. - healthy
Threshold Integer - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- interval Integer
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - matcher String
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- path String
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- port String
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - protocol String
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - timeout Integer
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- unhealthy
Threshold Integer - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
- enabled boolean
- Whether health checks are enabled. Defaults to
true
. - healthy
Threshold number - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- interval number
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - matcher string
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- path string
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- port string
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - protocol string
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - timeout number
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- unhealthy
Threshold number - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
- enabled bool
- Whether health checks are enabled. Defaults to
true
. - healthy_
threshold int - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- interval int
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - matcher str
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- path str
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- port str
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - protocol str
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - timeout int
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- unhealthy_
threshold int - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
- enabled Boolean
- Whether health checks are enabled. Defaults to
true
. - healthy
Threshold Number - Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
- interval Number
- Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda
target groups, it needs to be greater than the timeout of the underlyinglambda
. Defaults to 30. - matcher String
- The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol
must be one ofHTTP
orHTTPS
or thetarget_type
must belambda
. Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").- For gRPC-based target groups (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
isGRPC
), values can be between0
and99
. The default is12
. - When used with an Application Load Balancer (i.e., the
protocol
is one ofHTTP
orHTTPS
and theprotocol_version
is notGRPC
), values can be between200
and499
. The default is200
. - When used with a Network Load Balancer (i.e., the
protocol
is one ofTCP
,TCP_UDP
,UDP
, orTLS
), values can be between200
and599
. The default is200-399
. - When the
target_type
islambda
, values can be between200
and499
. The default is200
.
- For gRPC-based target groups (i.e., the
- path String
- Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
- For HTTP and HTTPS health checks, the default is
/
. - For gRPC health checks, the default is
/Amazon Web Services.ALB/healthcheck
.
- For HTTP and HTTPS health checks, the default is
- port String
- The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port
, to use the same port as the target group, or a valid port number between1
and65536
. Default istraffic-port
. - protocol String
- Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP
,HTTP
, orHTTPS
. TheTCP
protocol is not supported for health checks if the protocol of the target group isHTTP
orHTTPS
. Default isHTTP
. Cannot be specified when thetarget_type
islambda
. - timeout Number
- Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- unhealthy
Threshold Number - Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
TargetGroupStickiness, TargetGroupStickinessArgs
- Type string
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - int
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - string
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - Enabled bool
- Boolean to enable / disable
stickiness
. Default istrue
.
- Type string
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - int
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - string
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - Enabled bool
- Boolean to enable / disable
stickiness
. Default istrue
.
- type String
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - Integer
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - String
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - enabled Boolean
- Boolean to enable / disable
stickiness
. Default istrue
.
- type string
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - number
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - string
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - enabled boolean
- Boolean to enable / disable
stickiness
. Default istrue
.
- type str
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - int
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - str
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - enabled bool
- Boolean to enable / disable
stickiness
. Default istrue
.
- type String
- The type of sticky sessions. The only current possible values are
lb_cookie
,app_cookie
for ALBs,source_ip
for NLBs, andsource_ip_dest_ip
,source_ip_dest_ip_proto
for GWLBs. - Number
- Only used when the type is
lb_cookie
. The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). - String
- Name of the application based cookie. AWSALB, AWSALBAPP, and AWSALBTG prefixes are reserved and cannot be used. Only needed when type is
app_cookie
. - enabled Boolean
- Boolean to enable / disable
stickiness
. Default istrue
.
TargetGroupTargetFailover, TargetGroupTargetFailoverArgs
- On
Deregistration string - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - On
Unhealthy string - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
- On
Deregistration string - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - On
Unhealthy string - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
- on
Deregistration String - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - on
Unhealthy String - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
- on
Deregistration string - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - on
Unhealthy string - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
- on_
deregistration str - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - on_
unhealthy str - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
- on
Deregistration String - Indicates how the GWLB handles existing flows when a target is deregistered. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_unhealthy
. Default:no_rebalance
. - on
Unhealthy String - Indicates how the GWLB handles existing flows when a target is unhealthy. Possible values are
rebalance
andno_rebalance
. Must match the attribute value set foron_deregistration
. Default:no_rebalance
.
TargetGroupTargetGroupHealth, TargetGroupTargetGroupHealthArgs
- Dns
Failover TargetGroup Target Group Health Dns Failover - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- Unhealthy
State TargetRouting Group Target Group Health Unhealthy State Routing - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
- Dns
Failover TargetGroup Target Group Health Dns Failover - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- Unhealthy
State TargetRouting Group Target Group Health Unhealthy State Routing - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
- dns
Failover TargetGroup Target Group Health Dns Failover - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- unhealthy
State TargetRouting Group Target Group Health Unhealthy State Routing - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
- dns
Failover TargetGroup Target Group Health Dns Failover - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- unhealthy
State TargetRouting Group Target Group Health Unhealthy State Routing - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
- dns_
failover TargetGroup Target Group Health Dns Failover - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- unhealthy_
state_ Targetrouting Group Target Group Health Unhealthy State Routing - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
- dns
Failover Property Map - Block to configure DNS Failover requirements. See DNS Failover below for details on attributes.
- unhealthy
State Property MapRouting - Block to configure Unhealthy State Routing requirements. See Unhealthy State Routing below for details on attributes.
TargetGroupTargetGroupHealthDnsFailover, TargetGroupTargetGroupHealthDnsFailoverArgs
- Minimum
Healthy stringTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - Minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
- Minimum
Healthy stringTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - Minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy StringTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - minimum
Healthy StringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy stringTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum_
healthy_ strtargets_ count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - minimum_
healthy_ strtargets_ percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy StringTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to the maximum number of targets. The default isoff
. - minimum
Healthy StringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are
off
or an integer from1
to100
. The default isoff
.
TargetGroupTargetGroupHealthUnhealthyStateRouting, TargetGroupTargetGroupHealthUnhealthyStateRoutingArgs
- Minimum
Healthy intTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - Minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
- Minimum
Healthy intTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - Minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy IntegerTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - minimum
Healthy StringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy numberTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - minimum
Healthy stringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum_
healthy_ inttargets_ count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - minimum_
healthy_ strtargets_ percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
- minimum
Healthy NumberTargets Count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
1
to the maximum number of targets. The default is1
. - minimum
Healthy StringTargets Percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are
off
or an integer from1
to100
. The default isoff
.
TargetGroupTargetHealthState, TargetGroupTargetHealthStateArgs
- Enable
Unhealthy boolConnection Termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - Unhealthy
Draining intInterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
- Enable
Unhealthy boolConnection Termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - Unhealthy
Draining intInterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
- enable
Unhealthy BooleanConnection Termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - unhealthy
Draining IntegerInterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
- enable
Unhealthy booleanConnection Termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - unhealthy
Draining numberInterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
- enable_
unhealthy_ boolconnection_ termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - unhealthy_
draining_ intinterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
- enable
Unhealthy BooleanConnection Termination - Indicates whether the load balancer terminates connections to unhealthy targets. Possible values are
true
orfalse
. Default:true
. - unhealthy
Draining NumberInterval - Indicates the time to wait for in-flight requests to complete when a target becomes unhealthy. The range is
0-360000
. This value has to be set only ifenable_unhealthy_connection_termination
is set to false. Default:0
.
Import
Using pulumi import
, import Target Groups using their ARN. For example:
$ pulumi import aws:alb/targetGroup:TargetGroup app_front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:targetgroup/app-front-end/20cfe21448b66314
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.