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

Class CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTargetGroupPropsMixin.TargetDescriptionProperty>

Enclosing interface:

CfnTargetGroupPropsMixin.TargetDescriptionProperty

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

A builder for CfnTargetGroupPropsMixin.TargetDescriptionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	availabilityZone(String availabilityZone)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getAvailabilityZone()
CfnTargetGroupPropsMixin.TargetDescriptionProperty	build()	Builds the configured instance.
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	id(String id)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	id(IInstanceRef id)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	id(ILoadBalancerRef id)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	id(IFunctionRef id)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	port(Number port)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getPort()
CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder	quicServerId(String quicServerId)	Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getQuicServerId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

availabilityZone

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder availabilityZone(String availabilityZone)

Sets the value of CfnTargetGroupPropsMixin.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

id

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder id(String id)

Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()

Parameters:

id - The ID of the target. 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

id

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder id(IInstanceRef id)

Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()

Parameters:

id - The ID of the target. 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

id

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder id(ILoadBalancerRef id)

Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()

Parameters:

id - The ID of the target. 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

id

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder id(IFunctionRef id)

Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getId()

Parameters:

id - The ID of the target. 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

port

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

Sets the value of CfnTargetGroupPropsMixin.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. This parameter is not used if the target is a Lambda function.

Returns:

this

quicServerId

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty.Builder quicServerId(String quicServerId)

Sets the value of CfnTargetGroupPropsMixin.TargetDescriptionProperty.getQuicServerId()

Parameters:

quicServerId - The server ID for the targets. This value is required if the protocol is QUIC or TCP_QUIC and can't be used with other protocols.

The ID consists of the 0x prefix followed by 16 hexadecimal characters. Any letters must be lowercase. The value must be unique at the listener level. You can't modify the server ID for a registered target. You must deregister the target and then provide a new server ID when you register the target again.

Returns:

this

build

@Stability(Stable)
public CfnTargetGroupPropsMixin.TargetDescriptionProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnTargetGroupPropsMixin.TargetDescriptionProperty

Throws:

NullPointerException - if any required attribute was not provided