AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest Class Reference

#include <CreateTargetGroupRequest.h>

+ Inheritance diagram for Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest:

Public Member Functions

 CreateTargetGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateTargetGroupRequestWithName (const Aws::String &value)
 
CreateTargetGroupRequestWithName (Aws::String &&value)
 
CreateTargetGroupRequestWithName (const char *value)
 
const ProtocolEnumGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const ProtocolEnum &value)
 
void SetProtocol (ProtocolEnum &&value)
 
CreateTargetGroupRequestWithProtocol (const ProtocolEnum &value)
 
CreateTargetGroupRequestWithProtocol (ProtocolEnum &&value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateTargetGroupRequestWithPort (int value)
 
const Aws::StringGetVpcId () const
 
bool VpcIdHasBeenSet () const
 
void SetVpcId (const Aws::String &value)
 
void SetVpcId (Aws::String &&value)
 
void SetVpcId (const char *value)
 
CreateTargetGroupRequestWithVpcId (const Aws::String &value)
 
CreateTargetGroupRequestWithVpcId (Aws::String &&value)
 
CreateTargetGroupRequestWithVpcId (const char *value)
 
const ProtocolEnumGetHealthCheckProtocol () const
 
bool HealthCheckProtocolHasBeenSet () const
 
void SetHealthCheckProtocol (const ProtocolEnum &value)
 
void SetHealthCheckProtocol (ProtocolEnum &&value)
 
CreateTargetGroupRequestWithHealthCheckProtocol (const ProtocolEnum &value)
 
CreateTargetGroupRequestWithHealthCheckProtocol (ProtocolEnum &&value)
 
const Aws::StringGetHealthCheckPort () const
 
bool HealthCheckPortHasBeenSet () const
 
void SetHealthCheckPort (const Aws::String &value)
 
void SetHealthCheckPort (Aws::String &&value)
 
void SetHealthCheckPort (const char *value)
 
CreateTargetGroupRequestWithHealthCheckPort (const Aws::String &value)
 
CreateTargetGroupRequestWithHealthCheckPort (Aws::String &&value)
 
CreateTargetGroupRequestWithHealthCheckPort (const char *value)
 
bool GetHealthCheckEnabled () const
 
bool HealthCheckEnabledHasBeenSet () const
 
void SetHealthCheckEnabled (bool value)
 
CreateTargetGroupRequestWithHealthCheckEnabled (bool value)
 
const Aws::StringGetHealthCheckPath () const
 
bool HealthCheckPathHasBeenSet () const
 
void SetHealthCheckPath (const Aws::String &value)
 
void SetHealthCheckPath (Aws::String &&value)
 
void SetHealthCheckPath (const char *value)
 
CreateTargetGroupRequestWithHealthCheckPath (const Aws::String &value)
 
CreateTargetGroupRequestWithHealthCheckPath (Aws::String &&value)
 
CreateTargetGroupRequestWithHealthCheckPath (const char *value)
 
int GetHealthCheckIntervalSeconds () const
 
bool HealthCheckIntervalSecondsHasBeenSet () const
 
void SetHealthCheckIntervalSeconds (int value)
 
CreateTargetGroupRequestWithHealthCheckIntervalSeconds (int value)
 
int GetHealthCheckTimeoutSeconds () const
 
bool HealthCheckTimeoutSecondsHasBeenSet () const
 
void SetHealthCheckTimeoutSeconds (int value)
 
CreateTargetGroupRequestWithHealthCheckTimeoutSeconds (int value)
 
int GetHealthyThresholdCount () const
 
bool HealthyThresholdCountHasBeenSet () const
 
void SetHealthyThresholdCount (int value)
 
CreateTargetGroupRequestWithHealthyThresholdCount (int value)
 
int GetUnhealthyThresholdCount () const
 
bool UnhealthyThresholdCountHasBeenSet () const
 
void SetUnhealthyThresholdCount (int value)
 
CreateTargetGroupRequestWithUnhealthyThresholdCount (int value)
 
const MatcherGetMatcher () const
 
bool MatcherHasBeenSet () const
 
void SetMatcher (const Matcher &value)
 
void SetMatcher (Matcher &&value)
 
CreateTargetGroupRequestWithMatcher (const Matcher &value)
 
CreateTargetGroupRequestWithMatcher (Matcher &&value)
 
const TargetTypeEnumGetTargetType () const
 
bool TargetTypeHasBeenSet () const
 
void SetTargetType (const TargetTypeEnum &value)
 
void SetTargetType (TargetTypeEnum &&value)
 
CreateTargetGroupRequestWithTargetType (const TargetTypeEnum &value)
 
CreateTargetGroupRequestWithTargetType (TargetTypeEnum &&value)
 
- Public Member Functions inherited from Aws::ElasticLoadBalancingv2::ElasticLoadBalancingv2Request
virtual ~ElasticLoadBalancingv2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::ElasticLoadBalancingv2::ElasticLoadBalancingv2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 24 of file CreateTargetGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateTargetGroupRequest()

Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::CreateTargetGroupRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetHealthCheckEnabled()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckEnabled ( ) const
inline

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 or ip, health checks are always enabled and cannot be disabled.

Definition at line 358 of file CreateTargetGroupRequest.h.

◆ GetHealthCheckIntervalSeconds()

int Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckIntervalSeconds ( ) const
inline

The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.

Definition at line 441 of file CreateTargetGroupRequest.h.

◆ GetHealthCheckPath()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckPath ( ) const
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 389 of file CreateTargetGroupRequest.h.

◆ GetHealthCheckPort()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckPort ( ) const
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 300 of file CreateTargetGroupRequest.h.

◆ GetHealthCheckProtocol()

const ProtocolEnum& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckProtocol ( ) const
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 247 of file CreateTargetGroupRequest.h.

◆ GetHealthCheckTimeoutSeconds()

int Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthCheckTimeoutSeconds ( ) const
inline

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

Definition at line 479 of file CreateTargetGroupRequest.h.

◆ GetHealthyThresholdCount()

int Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetHealthyThresholdCount ( ) const
inline

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.

Definition at line 518 of file CreateTargetGroupRequest.h.

◆ GetMatcher()

const Matcher& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetMatcher ( ) const
inline

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

Definition at line 586 of file CreateTargetGroupRequest.h.

◆ GetName()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetName ( ) const
inline

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.

Definition at line 47 of file CreateTargetGroupRequest.h.

◆ GetPort()

int Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetPort ( ) const
inline

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.

Definition at line 159 of file CreateTargetGroupRequest.h.

◆ GetProtocol()

const ProtocolEnum& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetProtocol ( ) const
inline

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

Definition at line 106 of file CreateTargetGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateTargetGroupRequest.h.

◆ GetTargetType()

const TargetTypeEnum& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetTargetType ( ) const
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 631 of file CreateTargetGroupRequest.h.

◆ GetUnhealthyThresholdCount()

int Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetUnhealthyThresholdCount ( ) const
inline

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.

Definition at line 552 of file CreateTargetGroupRequest.h.

◆ GetVpcId()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::GetVpcId ( ) const
inline

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.

Definition at line 188 of file CreateTargetGroupRequest.h.

◆ HealthCheckEnabledHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckEnabledHasBeenSet ( ) const
inline

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 or ip, health checks are always enabled and cannot be disabled.

Definition at line 366 of file CreateTargetGroupRequest.h.

◆ HealthCheckIntervalSecondsHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckIntervalSecondsHasBeenSet ( ) const
inline

The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.

Definition at line 450 of file CreateTargetGroupRequest.h.

◆ HealthCheckPathHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckPathHasBeenSet ( ) const
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 395 of file CreateTargetGroupRequest.h.

◆ HealthCheckPortHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckPortHasBeenSet ( ) const
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 307 of file CreateTargetGroupRequest.h.

◆ HealthCheckProtocolHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckProtocolHasBeenSet ( ) const
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 256 of file CreateTargetGroupRequest.h.

◆ HealthCheckTimeoutSecondsHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthCheckTimeoutSecondsHasBeenSet ( ) const
inline

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

Definition at line 489 of file CreateTargetGroupRequest.h.

◆ HealthyThresholdCountHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::HealthyThresholdCountHasBeenSet ( ) const
inline

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.

Definition at line 526 of file CreateTargetGroupRequest.h.

◆ MatcherHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::MatcherHasBeenSet ( ) const
inline

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

Definition at line 592 of file CreateTargetGroupRequest.h.

◆ NameHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::NameHasBeenSet ( ) const
inline

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.

Definition at line 54 of file CreateTargetGroupRequest.h.

◆ PortHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::PortHasBeenSet ( ) const
inline

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.

Definition at line 166 of file CreateTargetGroupRequest.h.

◆ ProtocolHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::ProtocolHasBeenSet ( ) const
inline

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

Definition at line 115 of file CreateTargetGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetHealthCheckEnabled()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckEnabled ( bool  value)
inline

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 or ip, health checks are always enabled and cannot be disabled.

Definition at line 374 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckIntervalSeconds()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckIntervalSeconds ( int  value)
inline

The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.

Definition at line 459 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPath() [1/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPath ( const Aws::String value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 401 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPath() [2/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPath ( Aws::String &&  value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 407 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPath() [3/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPath ( const char *  value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 413 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPort() [1/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPort ( const Aws::String value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 314 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPort() [2/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPort ( Aws::String &&  value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 321 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckPort() [3/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckPort ( const char *  value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 328 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckProtocol() [1/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckProtocol ( const ProtocolEnum value)
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 265 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckProtocol() [2/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckProtocol ( ProtocolEnum &&  value)
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 274 of file CreateTargetGroupRequest.h.

◆ SetHealthCheckTimeoutSeconds()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthCheckTimeoutSeconds ( int  value)
inline

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

Definition at line 499 of file CreateTargetGroupRequest.h.

◆ SetHealthyThresholdCount()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetHealthyThresholdCount ( int  value)
inline

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.

Definition at line 534 of file CreateTargetGroupRequest.h.

◆ SetMatcher() [1/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetMatcher ( const Matcher value)
inline

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

Definition at line 598 of file CreateTargetGroupRequest.h.

◆ SetMatcher() [2/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetMatcher ( Matcher &&  value)
inline

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

Definition at line 604 of file CreateTargetGroupRequest.h.

◆ SetName() [1/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetName ( const Aws::String value)
inline

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.

Definition at line 61 of file CreateTargetGroupRequest.h.

◆ SetName() [2/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetName ( Aws::String &&  value)
inline

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.

Definition at line 68 of file CreateTargetGroupRequest.h.

◆ SetName() [3/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetName ( const char *  value)
inline

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.

Definition at line 75 of file CreateTargetGroupRequest.h.

◆ SetPort()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetPort ( int  value)
inline

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.

Definition at line 173 of file CreateTargetGroupRequest.h.

◆ SetProtocol() [1/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetProtocol ( const ProtocolEnum value)
inline

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

Definition at line 124 of file CreateTargetGroupRequest.h.

◆ SetProtocol() [2/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetProtocol ( ProtocolEnum &&  value)
inline

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

Definition at line 133 of file CreateTargetGroupRequest.h.

◆ SetTargetType() [1/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetTargetType ( const TargetTypeEnum value)
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 659 of file CreateTargetGroupRequest.h.

◆ SetTargetType() [2/2]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetTargetType ( TargetTypeEnum &&  value)
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 673 of file CreateTargetGroupRequest.h.

◆ SetUnhealthyThresholdCount()

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetUnhealthyThresholdCount ( int  value)
inline

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.

Definition at line 570 of file CreateTargetGroupRequest.h.

◆ SetVpcId() [1/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetVpcId ( const Aws::String value)
inline

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.

Definition at line 202 of file CreateTargetGroupRequest.h.

◆ SetVpcId() [2/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetVpcId ( Aws::String &&  value)
inline

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.

Definition at line 209 of file CreateTargetGroupRequest.h.

◆ SetVpcId() [3/3]

void Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::SetVpcId ( const char *  value)
inline

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.

Definition at line 216 of file CreateTargetGroupRequest.h.

◆ TargetTypeHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::TargetTypeHasBeenSet ( ) const
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 645 of file CreateTargetGroupRequest.h.

◆ UnhealthyThresholdCountHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::UnhealthyThresholdCountHasBeenSet ( ) const
inline

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.

Definition at line 561 of file CreateTargetGroupRequest.h.

◆ VpcIdHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::VpcIdHasBeenSet ( ) const
inline

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.

Definition at line 195 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckEnabled()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckEnabled ( bool  value)
inline

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 or ip, health checks are always enabled and cannot be disabled.

Definition at line 382 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckIntervalSeconds()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckIntervalSeconds ( int  value)
inline

The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.

Definition at line 468 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPath() [1/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPath ( const Aws::String value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 419 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPath() [2/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPath ( Aws::String &&  value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 425 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPath() [3/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPath ( const char *  value)
inline

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Definition at line 431 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPort() [1/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPort ( const Aws::String value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 335 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPort() [2/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPort ( Aws::String &&  value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 342 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckPort() [3/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckPort ( const char *  value)
inline

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Definition at line 349 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckProtocol() [1/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckProtocol ( const ProtocolEnum value)
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 283 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckProtocol() [2/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckProtocol ( ProtocolEnum &&  value)
inline

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Definition at line 292 of file CreateTargetGroupRequest.h.

◆ WithHealthCheckTimeoutSeconds()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthCheckTimeoutSeconds ( int  value)
inline

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

Definition at line 509 of file CreateTargetGroupRequest.h.

◆ WithHealthyThresholdCount()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithHealthyThresholdCount ( int  value)
inline

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.

Definition at line 542 of file CreateTargetGroupRequest.h.

◆ WithMatcher() [1/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithMatcher ( const Matcher value)
inline

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

Definition at line 610 of file CreateTargetGroupRequest.h.

◆ WithMatcher() [2/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithMatcher ( Matcher &&  value)
inline

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

Definition at line 616 of file CreateTargetGroupRequest.h.

◆ WithName() [1/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithName ( const Aws::String value)
inline

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.

Definition at line 82 of file CreateTargetGroupRequest.h.

◆ WithName() [2/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithName ( Aws::String &&  value)
inline

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.

Definition at line 89 of file CreateTargetGroupRequest.h.

◆ WithName() [3/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithName ( const char *  value)
inline

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.

Definition at line 96 of file CreateTargetGroupRequest.h.

◆ WithPort()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithPort ( int  value)
inline

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.

Definition at line 180 of file CreateTargetGroupRequest.h.

◆ WithProtocol() [1/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithProtocol ( const ProtocolEnum value)
inline

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

Definition at line 142 of file CreateTargetGroupRequest.h.

◆ WithProtocol() [2/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithProtocol ( ProtocolEnum &&  value)
inline

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

Definition at line 151 of file CreateTargetGroupRequest.h.

◆ WithTargetType() [1/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithTargetType ( const TargetTypeEnum value)
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 687 of file CreateTargetGroupRequest.h.

◆ WithTargetType() [2/2]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithTargetType ( TargetTypeEnum &&  value)
inline

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 - Targets are specified by instance ID. This is the default value.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Definition at line 701 of file CreateTargetGroupRequest.h.

◆ WithUnhealthyThresholdCount()

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithUnhealthyThresholdCount ( int  value)
inline

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.

Definition at line 579 of file CreateTargetGroupRequest.h.

◆ WithVpcId() [1/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithVpcId ( const Aws::String value)
inline

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.

Definition at line 223 of file CreateTargetGroupRequest.h.

◆ WithVpcId() [2/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithVpcId ( Aws::String &&  value)
inline

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.

Definition at line 230 of file CreateTargetGroupRequest.h.

◆ WithVpcId() [3/3]

CreateTargetGroupRequest& Aws::ElasticLoadBalancingv2::Model::CreateTargetGroupRequest::WithVpcId ( const char *  value)
inline

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.

Definition at line 237 of file CreateTargetGroupRequest.h.


The documentation for this class was generated from the following file: