software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnTargetGroup.TargetDescriptionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup.TargetDescriptionProperty.Builder

Enclosing interface:

CfnTargetGroup.TargetDescriptionProperty

public static final class CfnTargetGroup.TargetDescriptionProperty.Builder
extends java.lang.Object

A builder for CfnTargetGroup.TargetDescriptionProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnTargetGroup.TargetDescriptionProperty.Builder	availabilityZone(java.lang.String availabilityZone) Sets the value of CfnTargetGroup.TargetDescriptionProperty.getAvailabilityZone()
CfnTargetGroup.TargetDescriptionProperty	build() Builds the configured instance.
CfnTargetGroup.TargetDescriptionProperty.Builder	id(java.lang.String id) Sets the value of CfnTargetGroup.TargetDescriptionProperty.getId()
CfnTargetGroup.TargetDescriptionProperty.Builder	port(java.lang.Number port) Sets the value of CfnTargetGroup.TargetDescriptionProperty.getPort()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

id

public CfnTargetGroup.TargetDescriptionProperty.Builder id(java.lang.String id)

Sets the value of CfnTargetGroup.TargetDescriptionProperty.getId()

Parameters:

id - The ID of the target. This parameter is required. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function. If the target type is alb , specify the ARN of the Application Load Balancer target.

Returns:

this

availabilityZone

public CfnTargetGroup.TargetDescriptionProperty.Builder availabilityZone(java.lang.String availabilityZone)

Sets the value of CfnTargetGroup.TargetDescriptionProperty.getAvailabilityZone()

Parameters:

availabilityZone - An Availability Zone or `all` . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all .

This parameter is not supported if the target type of the target group is instance or alb .

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

If the target type is lambda , this parameter is optional and the only supported value is all .

Returns:

this

port

public CfnTargetGroup.TargetDescriptionProperty.Builder port(java.lang.Number port)

Sets the value of CfnTargetGroup.TargetDescriptionProperty.getPort()

Parameters:

port - The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb , the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.

Returns:

this

build

public CfnTargetGroup.TargetDescriptionProperty build()

Builds the configured instance.

Returns:

a new instance of CfnTargetGroup.TargetDescriptionProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided