Class CreateTargetGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTargetGroupRequest.Builder,
CreateTargetGroupRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Indicates whether health checks are enabled.final Integer
The approximate amount of time, in seconds, between health checks of an individual target.final String
[HTTP/HTTPS health checks] The destination for health checks on the targets.final String
The port the load balancer uses when performing health checks on targets.final ProtocolEnum
The protocol the load balancer uses when performing health checks on targets.final String
The protocol the load balancer uses when performing health checks on targets.final Integer
The amount of time, in seconds, during which no response from a target means a failed health check.final Integer
The number of consecutive health check successes required before considering a target healthy.The type of IP address used for this target group.final String
The type of IP address used for this target group.final Matcher
matcher()
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.final String
name()
The name of the target group.final Integer
port()
The port on which the targets receive traffic.final ProtocolEnum
protocol()
The protocol to use for routing traffic to the targets.final String
The protocol to use for routing traffic to the targets.final String
[HTTP/HTTPS protocol] The protocol version.static Class
<? extends CreateTargetGroupRequest.Builder> tags()
The tags to assign to the target group.final TargetTypeEnum
The type of target that you must specify when registering targets with this target group.final String
The type of target that you must specify when registering targets with this target group.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The number of consecutive health check failures required before considering a target unhealthy.final String
vpcId()
The identifier of the virtual private cloud (VPC).Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- 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:
-
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 returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- 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:
-
protocolVersion
[HTTP/HTTPS protocol] The protocol version. Specify
GRPC
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.- Returns:
- [HTTP/HTTPS protocol] The protocol version. Specify
GRPC
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.
-
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
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
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 returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- 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:
-
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 returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- 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:
-
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
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 isinstance
,ip
, oralb
, 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 isinstance
,ip
, oralb
, health checks are always enabled and cannot be disabled.
-
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
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
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
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
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
[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
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 returnTargetTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- 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:
-
-
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 returnTargetTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- 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:
-
-
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 theisEmpty()
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
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
The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnTargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
. - See Also:
-
ipAddressTypeAsString
The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnTargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateTargetGroupRequest.Builder,
CreateTargetGroupRequest> - Specified by:
toBuilder
in classElasticLoadBalancingV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-