Class: Aws::RTBFabric::Types::UpdateResponderGatewayRequest

Inherits:

Struct

• Object
• Struct
• Aws::RTBFabric::Types::UpdateResponderGatewayRequest

Defined in:

gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_routing_policy ⇒ String

  The client routing policy of the gateway.

• #client_token ⇒ String

  Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  An optional description for the responder gateway.

• #domain_name ⇒ String

  Domain name for the responder gateway.

• #gateway_id ⇒ String

  The unique identifier of the gateway.

• #listener_config ⇒ Types::ListenerConfig

  The listener configuration for the responder gateway.

• #managed_endpoint_configuration ⇒ Types::ManagedEndpointConfiguration

  The configuration for the managed endpoint.

• #port ⇒ Integer

  Networking port to use.

• #protocol ⇒ String

  Networking protocol to use.

• #trust_store_configuration ⇒ Types::TrustStoreConfiguration

  The configuration of the trust store.

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, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. 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)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :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)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description for the responder gateway.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_id ⇒ String

The unique identifier of the gateway.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#listener_config ⇒ Types::ListenerConfig

The listener configuration for the responder gateway.

Returns:

• (Types::ListenerConfig)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#managed_endpoint_configuration ⇒ Types::ManagedEndpointConfiguration

The configuration for the managed endpoint.

Returns:

• (Types::ManagedEndpointConfiguration)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.

Returns:

• (Integer)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.

Returns:

• (String)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end

#trust_store_configuration ⇒ Types::TrustStoreConfiguration

The configuration of the trust store.

Returns:

• (Types::TrustStoreConfiguration)

# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 3170

class UpdateResponderGatewayRequest < Struct.new(
  :domain_name,
  :port,
  :protocol,
  :listener_config,
  :trust_store_configuration,
  :managed_endpoint_configuration,
  :client_token,
  :gateway_id,
  :description,
  :client_routing_policy)
  SENSITIVE = []
  include Aws::Structure
end