Class: Aws::GlobalAccelerator::Types::CreateEndpointGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-globalaccelerator/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_configurationsArray<Types::EndpointConfiguration>

The list of endpoint objects.

Returns:



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_group_regionString

The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_interval_secondsInteger

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

Returns:

  • (Integer)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_pathString

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_portInteger

The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

Returns:

  • (Integer)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_protocolString

The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_tokenString

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#listener_arnString

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#port_overridesArray<Types::PortOverride>

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see [ Overriding listener ports] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html

Returns:



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#threshold_countInteger

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Returns:

  • (Integer)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_dial_percentageFloat

The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

Returns:

  • (Float)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/aws-sdk-globalaccelerator/types.rb', line 1065

class CreateEndpointGroupRequest < Struct.new(
  :listener_arn,
  :endpoint_group_region,
  :endpoint_configurations,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :idempotency_token,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end