Package software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2

Class CfnTargetGroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.CfnTargetGroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTargetGroupPropsMixin>

Enclosing class:

CfnTargetGroupPropsMixin

@Stability(Stable)
public static final class CfnTargetGroupPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTargetGroupPropsMixin>

A fluent builder for CfnTargetGroupPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTargetGroupPropsMixin	build()
static CfnTargetGroupPropsMixin.Builder	create()
static CfnTargetGroupPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTargetGroupPropsMixin.Builder	healthCheckEnabled(Boolean healthCheckEnabled)	Indicates whether health checks are enabled.
CfnTargetGroupPropsMixin.Builder	healthCheckEnabled(IResolvable healthCheckEnabled)	Indicates whether health checks are enabled.
CfnTargetGroupPropsMixin.Builder	healthCheckIntervalSeconds(Number healthCheckIntervalSeconds)	The approximate amount of time, in seconds, between health checks of an individual target.
CfnTargetGroupPropsMixin.Builder	healthCheckPath(String healthCheckPath)	[HTTP/HTTPS health checks] The destination for health checks on the targets.
CfnTargetGroupPropsMixin.Builder	healthCheckPort(String healthCheckPort)	The port the load balancer uses when performing health checks on targets.
CfnTargetGroupPropsMixin.Builder	healthCheckProtocol(String healthCheckProtocol)	The protocol the load balancer uses when performing health checks on targets.
CfnTargetGroupPropsMixin.Builder	healthCheckTimeoutSeconds(Number healthCheckTimeoutSeconds)	The amount of time, in seconds, during which no response from a target means a failed health check.
CfnTargetGroupPropsMixin.Builder	healthyThresholdCount(Number healthyThresholdCount)	The number of consecutive health check successes required before considering a target healthy.
CfnTargetGroupPropsMixin.Builder	ipAddressType(String ipAddressType)	The IP address type.
CfnTargetGroupPropsMixin.Builder	matcher(CfnTargetGroupPropsMixin.MatcherProperty matcher)	[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
CfnTargetGroupPropsMixin.Builder	matcher(IResolvable matcher)	[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
CfnTargetGroupPropsMixin.Builder	name(String name)	The name of the target group.
CfnTargetGroupPropsMixin.Builder	port(Number port)	The port on which the targets receive traffic.
CfnTargetGroupPropsMixin.Builder	protocol(String protocol)	The protocol to use for routing traffic to the targets.
CfnTargetGroupPropsMixin.Builder	protocolVersion(String protocolVersion)	[HTTP/HTTPS protocol] The protocol version.
CfnTargetGroupPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags.
CfnTargetGroupPropsMixin.Builder	targetControlPort(Number targetControlPort)	The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.
CfnTargetGroupPropsMixin.Builder	targetGroupAttributes(List<? extends Object> targetGroupAttributes)	The target group attributes.
CfnTargetGroupPropsMixin.Builder	targetGroupAttributes(IResolvable targetGroupAttributes)	The target group attributes.
CfnTargetGroupPropsMixin.Builder	targets(List<? extends Object> targets)	The targets.
CfnTargetGroupPropsMixin.Builder	targets(IResolvable targets)	The targets.
CfnTargetGroupPropsMixin.Builder	targetType(String targetType)	The type of target that you must specify when registering targets with this target group.
CfnTargetGroupPropsMixin.Builder	unhealthyThresholdCount(Number unhealthyThresholdCount)	The number of consecutive health check failures required before considering a target unhealthy.
CfnTargetGroupPropsMixin.Builder	vpcId(String vpcId)	The identifier of the virtual private cloud (VPC).
CfnTargetGroupPropsMixin.Builder	vpcId(IVPCRef vpcId)	The identifier of the virtual private cloud (VPC).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnTargetGroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTargetGroupPropsMixin.Builder.

create

@Stability(Stable)
public static CfnTargetGroupPropsMixin.Builder create()

Returns:

a new instance of CfnTargetGroupPropsMixin.Builder.

healthCheckEnabled

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckEnabled(Boolean healthCheckEnabled)

Indicates whether health checks are enabled.

If the target type is lambda , health checks are disabled by default but can be enabled. If the target type is instance , ip , or alb , health checks are always enabled and can't be disabled.

Parameters:

healthCheckEnabled - Indicates whether health checks are enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled

healthCheckEnabled

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckEnabled(IResolvable healthCheckEnabled)

Indicates whether health checks are enabled.

If the target type is lambda , health checks are disabled by default but can be enabled. If the target type is instance , ip , or alb , health checks are always enabled and can't be disabled.

Parameters:

healthCheckEnabled - Indicates whether health checks are enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled

healthCheckIntervalSeconds

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckIntervalSeconds(Number healthCheckIntervalSeconds)

The approximate amount of time, in seconds, between health checks of an individual target.

The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda , the default is 35 seconds.

Parameters:

healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds

healthCheckPath

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckPath(String healthCheckPath)

[HTTP/HTTPS health checks] The destination for health checks on the targets.

[HTTP1 or HTTP2 protocol version] The ping path. The default is /.

[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is / AWS .ALB/healthcheck.

Parameters:

healthCheckPath - [HTTP/HTTPS health checks] The destination for health checks on the targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath

healthCheckPort

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckPort(String healthCheckPort)

The port the load balancer uses when performing health checks on targets.

If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC the default is traffic-port , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

Parameters:

healthCheckPort - The port the load balancer uses when performing health checks on targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport

healthCheckProtocol

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckProtocol(String healthCheckProtocol)

The protocol the load balancer uses when performing health checks on targets.

For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

Parameters:

healthCheckProtocol - The protocol the load balancer uses when performing health checks on targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol

healthCheckTimeoutSeconds

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthCheckTimeoutSeconds(Number healthCheckTimeoutSeconds)

The 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.

Parameters:

healthCheckTimeoutSeconds - The amount of time, in seconds, during which no response from a target means a failed health check. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds

healthyThresholdCount

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder healthyThresholdCount(Number healthyThresholdCount)

The number of consecutive health check successes required before considering a target healthy.

The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda , the default is 5.

Parameters:

healthyThresholdCount - The number of consecutive health check successes required before considering a target healthy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount

ipAddressType

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder ipAddressType(String ipAddressType)

The IP address type.

The default value is ipv4 .

Parameters:

ipAddressType - The IP address type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-ipaddresstype

matcher

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder matcher(IResolvable matcher)

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

Parameters:

matcher - [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher

matcher

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder matcher(CfnTargetGroupPropsMixin.MatcherProperty matcher)

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

Parameters:

matcher - [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher

name

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder name(String name)

The name of the target group.

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.

Parameters:

name - The name of the target group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name

port

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder port(Number port)

The port on which the targets receive traffic.

This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

Parameters:

port - The port on which the targets receive traffic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port

protocol

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder protocol(String protocol)

The protocol to use for routing traffic to the targets.

For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.

Parameters:

protocol - The protocol to use for routing traffic to the targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol

protocolVersion

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder protocolVersion(String protocolVersion)

[HTTP/HTTPS protocol] The protocol version.

The possible values are GRPC , HTTP1 , and HTTP2 .

Parameters:

protocolVersion - [HTTP/HTTPS protocol] The protocol version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocolversion

tags

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder tags(List<? extends CfnTag> tags)

The tags.

Parameters:

tags - The tags. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags

targetControlPort

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targetControlPort(Number targetControlPort)

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

Parameters:

targetControlPort - The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetcontrolport

targetGroupAttributes

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targetGroupAttributes(IResolvable targetGroupAttributes)

The target group attributes.

Attributes that you do not modify retain their current values.

Parameters:

targetGroupAttributes - The target group attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes

targetGroupAttributes

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targetGroupAttributes(List<? extends Object> targetGroupAttributes)

The target group attributes.

Attributes that you do not modify retain their current values.

Parameters:

targetGroupAttributes - The target group attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes

targets

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targets(IResolvable targets)

The targets.

Parameters:

targets - The targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets

targets

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targets(List<? extends Object> targets)

The targets.

Parameters:

targets - The targets. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets

targetType

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder targetType(String targetType)

The type of target that you must specify when registering targets with this target group.

You can't specify targets for a target group using more than one target type.

• instance - Register targets by instance ID. This is the default value.
• ip - Register targets by IP address. You can 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.
• lambda - Register a single Lambda function as a target.
• alb - Register a single Application Load Balancer as a target.

Parameters:

targetType - The type of target that you must specify when registering targets with this target group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype

unhealthyThresholdCount

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder unhealthyThresholdCount(Number unhealthyThresholdCount)

The number of consecutive health check failures required before considering a target unhealthy.

The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda , the default is 5.

Parameters:

unhealthyThresholdCount - The number of consecutive health check failures required before considering a target unhealthy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount

vpcId

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder vpcId(String vpcId)

The identifier of the virtual private cloud (VPC).

If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

Parameters:

vpcId - The identifier of the virtual private cloud (VPC). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid

vpcId

@Stability(Stable)
public CfnTargetGroupPropsMixin.Builder vpcId(IVPCRef vpcId)

The identifier of the virtual private cloud (VPC).

If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

Parameters:

vpcId - The identifier of the virtual private cloud (VPC). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid

build

@Stability(Stable)
public CfnTargetGroupPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTargetGroupPropsMixin>

Returns:

a newly built instance of CfnTargetGroupPropsMixin.