Class: Aws::RTBFabric::Types::CreateResponderGatewayRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_routing_policy ⇒ String

The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:

  • AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.

  • ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.

If you don't specify a value, RTB Fabric uses AVAILABILITY_ZONE_AFFINITY. To get the behavior of ANY_AVAILABILITY_ZONE, create the gateway with subnets in more than one Availability Zone. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description for the responder gateway.

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name for the responder gateway.

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_type ⇒ String

The type of gateway. Valid values are EXTERNAL or INTERNAL.

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#listener_config ⇒ Types::ListenerConfig

Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.

Returns:



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#managed_endpoint_configuration ⇒ Types::ManagedEndpointConfiguration

The configuration for the managed endpoint.

Returns:



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The networking port to use.

Returns:

  • (Integer) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The networking protocol to use.

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The unique identifiers of the security groups.

Returns:

  • (Array<String>) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

Unique identifiers of the subnets. A service quota for your account sets the number of Availability Zones that your subnets can span. By default, this quota is one Availability Zone. To span more Availability Zones, request a quota increase.

Returns:

  • (Array<String>) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

  • (Hash<String,String>) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#trust_store_configuration ⇒ Types::TrustStoreConfiguration

The configuration of the trust store.

Returns:



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The unique identifier of the Virtual Private Cloud (VPC).

Returns:

  • (String) 


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 834

class CreateResponderGatewayRequest < Struct.new(
  :vpc_id,
  :subnet_ids,
  :security_group_ids,
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :description,
  :tags,
  :gateway_type,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end