Class: Aws::AgentDiscovery::EndpointParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::AgentDiscovery::EndpointParameters
- Defined in:
- gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb
Overview
Endpoint parameters used to influence endpoints per request.
Constant Summary collapse
- PARAM_MAP =
{ 'Region' => :region, 'UseFIPS' => :use_fips, 'UseDualStack' => :use_dual_stack, 'Endpoint' => :endpoint, }.freeze
Instance Attribute Summary collapse
-
#endpoint ⇒ String
Override the endpoint used to send this request.
-
#region ⇒ String
The AWS Region the client is configured for.
-
#use_dual_stack ⇒ Boolean
When true, send the request to a dual-stack endpoint.
-
#use_fips ⇒ Boolean
When true, send the request to a FIPS-compliant endpoint.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(options = {}) ⇒ EndpointParameters
constructor
A new instance of EndpointParameters.
Constructor Details
#initialize(options = {}) ⇒ EndpointParameters
Returns a new instance of EndpointParameters.
51 52 53 54 55 56 57 58 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 51 def initialize( = {}) self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:endpoint] = [:endpoint] end |
Instance Attribute Details
#endpoint ⇒ String
Override the endpoint used to send this request.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :use_fips, :use_dual_stack, :endpoint, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'UseFIPS' => :use_fips, 'UseDualStack' => :use_dual_stack, 'Endpoint' => :endpoint, }.freeze end def initialize( = {}) self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:endpoint] = [:endpoint] end def self.create(config, ={}) new({ region: config.region, use_fips: config.use_fips_endpoint, use_dual_stack: config.use_dualstack_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), }.merge()) end end |
#region ⇒ String
The AWS Region the client is configured for. us-east-1, eu-west-1 and ap-northeast-1 resolve to their own Regional endpoint; any other Region resolves to the standard Regional pattern, which Agent Discovery does not serve.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :use_fips, :use_dual_stack, :endpoint, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'UseFIPS' => :use_fips, 'UseDualStack' => :use_dual_stack, 'Endpoint' => :endpoint, }.freeze end def initialize( = {}) self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:endpoint] = [:endpoint] end def self.create(config, ={}) new({ region: config.region, use_fips: config.use_fips_endpoint, use_dual_stack: config.use_dualstack_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), }.merge()) end end |
#use_dual_stack ⇒ Boolean
When true, send the request to a dual-stack endpoint. Agent Discovery's Regional endpoints already are, so they resolve unchanged.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :use_fips, :use_dual_stack, :endpoint, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'UseFIPS' => :use_fips, 'UseDualStack' => :use_dual_stack, 'Endpoint' => :endpoint, }.freeze end def initialize( = {}) self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:endpoint] = [:endpoint] end def self.create(config, ={}) new({ region: config.region, use_fips: config.use_fips_endpoint, use_dual_stack: config.use_dualstack_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), }.merge()) end end |
#use_fips ⇒ Boolean
When true, send the request to a FIPS-compliant endpoint. Agent Discovery has none, so this is an error.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :use_fips, :use_dual_stack, :endpoint, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'UseFIPS' => :use_fips, 'UseDualStack' => :use_dual_stack, 'Endpoint' => :endpoint, }.freeze end def initialize( = {}) self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? self[:endpoint] = [:endpoint] end def self.create(config, ={}) new({ region: config.region, use_fips: config.use_fips_endpoint, use_dual_stack: config.use_dualstack_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), }.merge()) end end |
Class Method Details
.create(config, options = {}) ⇒ Object
60 61 62 63 64 65 66 67 |
# File 'gems/aws-sdk-agentdiscovery/lib/aws-sdk-agentdiscovery/endpoint_parameters.rb', line 60 def self.create(config, ={}) new({ region: config.region, use_fips: config.use_fips_endpoint, use_dual_stack: config.use_dualstack_endpoint, endpoint: (config.endpoint.to_s unless config.regional_endpoint), }.merge()) end |