Class: Aws::GlobalAccelerator::Types::AllowCustomRoutingTrafficRequest

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 AllowCustomRoutingTrafficRequest data as a hash:

{
  endpoint_group_arn: "GenericString", # required
  endpoint_id: "GenericString", # required
  destination_addresses: ["IpAddress"],
  destination_ports: [1],
  allow_all_traffic_to_endpoint: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_all_traffic_to_endpointBoolean

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

Returns:

  • (Boolean)


309
310
311
312
313
314
315
316
317
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 309

class AllowCustomRoutingTrafficRequest < Struct.new(
  :endpoint_group_arn,
  :endpoint_id,
  :destination_addresses,
  :destination_ports,
  :allow_all_traffic_to_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#destination_addressesArray<String>

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

Returns:

  • (Array<String>)


309
310
311
312
313
314
315
316
317
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 309

class AllowCustomRoutingTrafficRequest < Struct.new(
  :endpoint_group_arn,
  :endpoint_id,
  :destination_addresses,
  :destination_ports,
  :allow_all_traffic_to_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#destination_portsArray<Integer>

A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

Returns:

  • (Array<Integer>)


309
310
311
312
313
314
315
316
317
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 309

class AllowCustomRoutingTrafficRequest < Struct.new(
  :endpoint_group_arn,
  :endpoint_id,
  :destination_addresses,
  :destination_ports,
  :allow_all_traffic_to_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_group_arnString

The Amazon Resource Name (ARN) of the endpoint group.

Returns:

  • (String)


309
310
311
312
313
314
315
316
317
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 309

class AllowCustomRoutingTrafficRequest < Struct.new(
  :endpoint_group_arn,
  :endpoint_id,
  :destination_addresses,
  :destination_ports,
  :allow_all_traffic_to_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_idString

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Returns:

  • (String)


309
310
311
312
313
314
315
316
317
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 309

class AllowCustomRoutingTrafficRequest < Struct.new(
  :endpoint_group_arn,
  :endpoint_id,
  :destination_addresses,
  :destination_ports,
  :allow_all_traffic_to_endpoint)
  SENSITIVE = []
  include Aws::Structure
end