Class: Aws::STS::EndpointParameters

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sts/endpoint_parameters.rb

Overview

Endpoint parameters used to influence endpoints per request.

Constant Summary collapse

PARAM_MAP = 
{
  'Region' => :region,
  'UseDualStack' => :use_dual_stack,
  'UseFIPS' => :use_fips,
  'Endpoint' => :endpoint,
  'UseGlobalEndpoint' => :use_global_endpoint,
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Aws::Structure

#empty?, included, #key?, new, #to_h, #to_s

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 58

def initialize(options = {})
  self[:region] = options[:region]
  self[:use_dual_stack] = options[:use_dual_stack]
  self[:use_dual_stack] = false if self[:use_dual_stack].nil?
  self[:use_fips] = options[:use_fips]
  self[:use_fips] = false if self[:use_fips].nil?
  self[:endpoint] = options[:endpoint]
  self[:use_global_endpoint] = options[:use_global_endpoint]
  self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
end

Instance Attribute Details

#endpoint ⇒ String

Override the endpoint used to send this request

Returns:

  • (String) 


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
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 38

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :use_global_endpoint,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'UseGlobalEndpoint' => :use_global_endpoint,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:endpoint] = options[:endpoint]
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_dual_stack: config.use_dualstack_endpoint,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_global_endpoint: config.sts_regional_endpoints == 'legacy',
    }.merge(options))
  end
end

#region ⇒ String

The AWS region used to dispatch the request.

Returns:

  • (String) 


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
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 38

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :use_global_endpoint,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'UseGlobalEndpoint' => :use_global_endpoint,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:endpoint] = options[:endpoint]
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_dual_stack: config.use_dualstack_endpoint,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_global_endpoint: config.sts_regional_endpoints == 'legacy',
    }.merge(options))
  end
end

#use_dual_stack ⇒ Boolean

When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

Returns:

  • (Boolean) 


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
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 38

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :use_global_endpoint,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'UseGlobalEndpoint' => :use_global_endpoint,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:endpoint] = options[:endpoint]
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_dual_stack: config.use_dualstack_endpoint,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_global_endpoint: config.sts_regional_endpoints == 'legacy',
    }.merge(options))
  end
end

#use_fips ⇒ Boolean

When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.

Returns:

  • (Boolean) 


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
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 38

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :use_global_endpoint,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'UseGlobalEndpoint' => :use_global_endpoint,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:endpoint] = options[:endpoint]
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_dual_stack: config.use_dualstack_endpoint,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_global_endpoint: config.sts_regional_endpoints == 'legacy',
    }.merge(options))
  end
end

#use_global_endpoint ⇒ Boolean

Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

Returns:

  • (Boolean) 


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
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 38

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :use_global_endpoint,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'UseGlobalEndpoint' => :use_global_endpoint,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:endpoint] = options[:endpoint]
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_dual_stack: config.use_dualstack_endpoint,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_global_endpoint: config.sts_regional_endpoints == 'legacy',
    }.merge(options))
  end
end

Class Method Details

.create(config, options = {}) ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'lib/aws-sdk-sts/endpoint_parameters.rb', line 69

def self.create(config, options={})
  new({
    region: config.region,
    use_dual_stack: config.use_dualstack_endpoint,
    use_fips: config.use_fips_endpoint,
    endpoint: (config.endpoint.to_s unless config.regional_endpoint),
    use_global_endpoint: config.sts_regional_endpoints == 'legacy',
  }.merge(options))
end