Class: Aws::GlobalAccelerator::Types::CreateListenerRequest

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

Overview

Note:

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

{
  accelerator_arn: "GenericString", # required
  port_ranges: [ # required
    {
      from_port: 1,
      to_port: 1,
    },
  ],
  protocol: "TCP", # required, accepts TCP, UDP
  client_affinity: "NONE", # accepts NONE, SOURCE_IP
  idempotency_token: "IdempotencyToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_arnString

The Amazon Resource Name (ARN) of your accelerator.

Returns:

  • (String)


1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 1044

class CreateListenerRequest < Struct.new(
  :accelerator_arn,
  :port_ranges,
  :protocol,
  :client_affinity,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_affinityString

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

Returns:

  • (String)


1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 1044

class CreateListenerRequest < Struct.new(
  :accelerator_arn,
  :port_ranges,
  :protocol,
  :client_affinity,
  :idempotency_token)
  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)


1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 1044

class CreateListenerRequest < Struct.new(
  :accelerator_arn,
  :port_ranges,
  :protocol,
  :client_affinity,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#port_rangesArray<Types::PortRange>

The list of port ranges to support for connections from clients to your accelerator.

Returns:



1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 1044

class CreateListenerRequest < Struct.new(
  :accelerator_arn,
  :port_ranges,
  :protocol,
  :client_affinity,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

The protocol for connections from clients to your accelerator.

Returns:

  • (String)


1044
1045
1046
1047
1048
1049
1050
1051
1052
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 1044

class CreateListenerRequest < Struct.new(
  :accelerator_arn,
  :port_ranges,
  :protocol,
  :client_affinity,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end