software.amazon.awssdk.services.elasticloadbalancingv2.model

Class CreateTargetGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request

software.amazon.awssdk.services.elasticloadbalancingv2.model.CreateTargetGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTargetGroupRequest
extends ElasticLoadBalancingV2Request
implements ToCopyableBuilder<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTargetGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTargetGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Boolean	healthCheckEnabled() Indicates whether health checks are enabled.
Integer	healthCheckIntervalSeconds() The approximate amount of time, in seconds, between health checks of an individual target.
String	healthCheckPath() [HTTP/HTTPS health checks] The destination for health checks on the targets.
String	healthCheckPort() The port the load balancer uses when performing health checks on targets.
ProtocolEnum	healthCheckProtocol() The protocol the load balancer uses when performing health checks on targets.
String	healthCheckProtocolAsString() The protocol the load balancer uses when performing health checks on targets.
Integer	healthCheckTimeoutSeconds() The amount of time, in seconds, during which no response from a target means a failed health check.
Integer	healthyThresholdCount() The number of consecutive health check successes required before considering a target healthy.
TargetGroupIpAddressTypeEnum	ipAddressType() The type of IP address used for this target group.
String	ipAddressTypeAsString() The type of IP address used for this target group.
Matcher	matcher() [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
String	name() The name of the target group.
Integer	port() The port on which the targets receive traffic.
ProtocolEnum	protocol() The protocol to use for routing traffic to the targets.
String	protocolAsString() The protocol to use for routing traffic to the targets.
String	protocolVersion() [HTTP/HTTPS protocol] The protocol version.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTargetGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags to assign to the target group.
TargetTypeEnum	targetType() The type of target that you must specify when registering targets with this target group.
String	targetTypeAsString() The type of target that you must specify when registering targets with this target group.
CreateTargetGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	unhealthyThresholdCount() The number of consecutive health check failures required before considering a target unhealthy.
String	vpcId() The identifier of the virtual private cloud (VPC).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final 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.

Returns:

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.

protocol

public final ProtocolEnum 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, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

See Also:

ProtocolEnum

protocolAsString

public final String protocolAsString()

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, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

See Also:

ProtocolEnum

protocolVersion

public final String protocolVersion()

[HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

Returns:

[HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

port

public final Integer 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.

Returns:

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.

vpcId

public final 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.

Returns:

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.

healthCheckProtocol

public final ProtocolEnum 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, and TCP_UDP protocols are not supported for health checks.

If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

Returns:

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, and TCP_UDP protocols are not supported for health checks.

See Also:

ProtocolEnum

healthCheckProtocolAsString

public final String healthCheckProtocolAsString()

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, and TCP_UDP protocols are not supported for health checks.

If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

Returns:

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, and TCP_UDP protocols are not supported for health checks.

See Also:

ProtocolEnum

healthCheckPort

public final String healthCheckPort()

The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, 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.

Returns:

The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, 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.

healthCheckEnabled

public final 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 cannot be disabled.

Returns:

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 cannot be disabled.

healthCheckPath

public final 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 /Amazon Web Services.ALB/healthcheck.

Returns:

[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 /Amazon Web Services.ALB/healthcheck.

healthCheckIntervalSeconds

public final Integer 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, 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.

Returns:

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

healthCheckTimeoutSeconds

public final Integer 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.

Returns:

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.

healthyThresholdCount

public final Integer 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.

Returns:

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.

unhealthyThresholdCount

public final Integer 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, 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.

Returns:

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

matcher

public final Matcher 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 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.

Returns:

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

targetType

public final TargetTypeEnum 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.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

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.

See Also:

TargetTypeEnum

targetTypeAsString

public final String targetTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

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.

See Also:

TargetTypeEnum

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The tags to assign to the target group.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags to assign to the target group.

ipAddressType

public final TargetGroupIpAddressTypeEnum ipAddressType()

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

Returns:

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

See Also:

TargetGroupIpAddressTypeEnum

ipAddressTypeAsString

public final String ipAddressTypeAsString()

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

Returns:

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

See Also:

TargetGroupIpAddressTypeEnum

toBuilder

public CreateTargetGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>

Specified by:

toBuilder in class ElasticLoadBalancingV2Request

builder

public static CreateTargetGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTargetGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo