Class: Aws::ElasticLoadBalancingV2::Types::ModifyTargetGroupInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticLoadBalancingV2::Types::ModifyTargetGroupInput
- Defined in:
- gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb
Overview
When making an API call, you may pass ModifyTargetGroupInput data as a hash:
{
target_group_arn: "TargetGroupArn", # required
health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE
health_check_port: "HealthCheckPort",
health_check_path: "Path",
health_check_enabled: false,
health_check_interval_seconds: 1,
health_check_timeout_seconds: 1,
healthy_threshold_count: 1,
unhealthy_threshold_count: 1,
matcher: {
http_code: "HttpCode",
grpc_code: "GrpcCode",
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#health_check_enabled ⇒ Boolean
Indicates whether health checks are enabled.
-
#health_check_interval_seconds ⇒ Integer
The approximate amount of time, in seconds, between health checks of an individual target.
-
#health_check_path ⇒ String
[HTTP/HTTPS health checks] The destination for health checks on the targets.
-
#health_check_port ⇒ String
The port the load balancer uses when performing health checks on targets.
-
#health_check_protocol ⇒ String
The protocol the load balancer uses when performing health checks on targets.
-
#health_check_timeout_seconds ⇒ Integer
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
-
#healthy_threshold_count ⇒ Integer
The number of consecutive health checks successes required before considering an unhealthy target healthy.
-
#matcher ⇒ Types::Matcher
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
-
#target_group_arn ⇒ String
The Amazon Resource Name (ARN) of the target group.
-
#unhealthy_threshold_count ⇒ Integer
The number of consecutive health check failures required before considering the target unhealthy.
Instance Attribute Details
#health_check_enabled ⇒ Boolean
Indicates whether health checks are enabled.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#health_check_interval_seconds ⇒ Integer
The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#health_check_path ⇒ String
[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.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#health_check_port ⇒ String
The port the load balancer uses when performing health checks on targets.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#health_check_protocol ⇒ String
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. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#health_check_timeout_seconds ⇒ Integer
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#healthy_threshold_count ⇒ Integer
The number of consecutive health checks successes required before considering an unhealthy target healthy.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#matcher ⇒ Types::Matcher
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#target_group_arn ⇒ String
The Amazon Resource Name (ARN) of the target group.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |
#unhealthy_threshold_count ⇒ Integer
The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3024 class ModifyTargetGroupInput < Struct.new( :target_group_arn, :health_check_protocol, :health_check_port, :health_check_path, :health_check_enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :unhealthy_threshold_count, :matcher) SENSITIVE = [] include Aws::Structure end |