Class: Aws::OpenSearchMemory::EndpointParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::OpenSearchMemory::EndpointParameters
- Defined in:
- gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb
Overview
Endpoint parameters used to influence endpoints per request.
Constant Summary collapse
- PARAM_MAP =
{ 'Region' => :region, 'Endpoint' => :endpoint, 'SpaceId' => :space_id, 'UseFIPS' => :use_fips, }.freeze
Instance Attribute Summary collapse
-
#endpoint ⇒ string
An endpoint URL to use instead of the one the rules resolve.
-
#region ⇒ string
The AWS Region to send the request to.
-
#space_id ⇒ string
The ID of the space the request targets.
-
#use_fips ⇒ boolean
When true, send the request to a FIPS 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 59 60 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 51 def initialize( = {}) self[:region] = [:region] if self[:region].nil? raise ArgumentError, "Missing required EndpointParameter: :region" end self[:endpoint] = [:endpoint] self[:space_id] = [:space_id] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? end |
Instance Attribute Details
#endpoint ⇒ string
An endpoint URL to use instead of the one the rules resolve.
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 69 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :endpoint, :space_id, :use_fips, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'Endpoint' => :endpoint, 'SpaceId' => :space_id, 'UseFIPS' => :use_fips, }.freeze end def initialize( = {}) self[:region] = [:region] if self[:region].nil? raise ArgumentError, "Missing required EndpointParameter: :region" end self[:endpoint] = [:endpoint] self[:space_id] = [:space_id] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? end def self.create(config, ={}) new({ region: config.region, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_fips: config.use_fips_endpoint, }.merge()) end end |
#region ⇒ string
The AWS Region to send the request to.
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 69 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :endpoint, :space_id, :use_fips, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'Endpoint' => :endpoint, 'SpaceId' => :space_id, 'UseFIPS' => :use_fips, }.freeze end def initialize( = {}) self[:region] = [:region] if self[:region].nil? raise ArgumentError, "Missing required EndpointParameter: :region" end self[:endpoint] = [:endpoint] self[:space_id] = [:space_id] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? end def self.create(config, ={}) new({ region: config.region, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_fips: config.use_fips_endpoint, }.merge()) end end |
#space_id ⇒ string
The ID of the space the request targets. When set, the request goes to that space's endpoint.
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 69 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :endpoint, :space_id, :use_fips, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'Endpoint' => :endpoint, 'SpaceId' => :space_id, 'UseFIPS' => :use_fips, }.freeze end def initialize( = {}) self[:region] = [:region] if self[:region].nil? raise ArgumentError, "Missing required EndpointParameter: :region" end self[:endpoint] = [:endpoint] self[:space_id] = [:space_id] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? end def self.create(config, ={}) new({ region: config.region, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_fips: config.use_fips_endpoint, }.merge()) end end |
#use_fips ⇒ boolean
When true, send the request to a FIPS endpoint. The service has no FIPS endpoint, so the request fails.
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 69 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 33 EndpointParameters = Struct.new( :region, :endpoint, :space_id, :use_fips, ) do include Aws::Structure # @api private class << self PARAM_MAP = { 'Region' => :region, 'Endpoint' => :endpoint, 'SpaceId' => :space_id, 'UseFIPS' => :use_fips, }.freeze end def initialize( = {}) self[:region] = [:region] if self[:region].nil? raise ArgumentError, "Missing required EndpointParameter: :region" end self[:endpoint] = [:endpoint] self[:space_id] = [:space_id] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? end def self.create(config, ={}) new({ region: config.region, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_fips: config.use_fips_endpoint, }.merge()) end end |
Class Method Details
.create(config, options = {}) ⇒ Object
62 63 64 65 66 67 68 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb', line 62 def self.create(config, ={}) new({ region: config.region, endpoint: (config.endpoint.to_s unless config.regional_endpoint), use_fips: config.use_fips_endpoint, }.merge()) end |