You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::CreateTargetGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

When making an API call, you may pass CreateTargetGroupInput data as a hash:

{
  name: "TargetGroupName", # required
  protocol: "HTTP", # required, accepts HTTP, HTTPS
  port: 1, # required
  vpc_id: "VpcId", # required
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS
  health_check_port: "HealthCheckPort",
  health_check_path: "Path",
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode", # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_interval_secondsInteger

The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.

Returns:

  • (Integer)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#health_check_pathString

The ping path that is the destination on the targets for health checks. The default is /.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#health_check_portString

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

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#health_check_protocolString

The protocol the load balancer uses when performing health checks on targets. The default is the HTTP protocol.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#health_check_timeout_secondsInteger

The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.

Returns:

  • (Integer)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#healthy_threshold_countInteger

The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.

Returns:

  • (Integer)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#matcherTypes::Matcher

The HTTP codes to use when checking for a successful response from a target. The default is 200.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#nameString

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:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#portInteger

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.

Returns:

  • (Integer)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#protocolString

The protocol to use for routing traffic to the targets.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#unhealthy_threshold_countInteger

The number of consecutive health check failures required before considering a target unhealthy. The default is 2.

Returns:

  • (Integer)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end

#vpc_idString

The identifier of the virtual private cloud (VPC).

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 456

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher)
  include Aws::Structure
end