Class: Aws::ACM::EndpointParameters

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

Overview

Endpoint parameters used to influence endpoints per request.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 58

def initialize(options = {})
  self[:region] = options[:region]
  if self[:region].nil?
    raise ArgumentError, "Missing required EndpointParameter: :region"
  end
  self[:endpoint] = options[:endpoint]
  self[:use_fips] = options[:use_fips]
  self[:use_fips] = false if self[:use_fips].nil?
  self[:use_dual_stack] = options[:use_dual_stack]
  self[:use_dual_stack] = false if self[:use_dual_stack].nil?
  self[:service_type] = options[:service_type]
  if self[:service_type].nil?
    raise ArgumentError, "Missing required EndpointParameter: :service_type"
  end
end

Instance Attribute Details

#endpoint ⇒ string

Override the endpoint used to send requests.

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
79
80
81
82
83
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 38

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

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

  def initialize(options = {})
    self[:region] = options[:region]
    if self[:region].nil?
      raise ArgumentError, "Missing required EndpointParameter: :region"
    end
    self[:endpoint] = options[:endpoint]
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:service_type] = options[:service_type]
    if self[:service_type].nil?
      raise ArgumentError, "Missing required EndpointParameter: :service_type"
    end
  end

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

#region ⇒ string

The AWS region to send requests to.

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
79
80
81
82
83
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 38

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

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

  def initialize(options = {})
    self[:region] = options[:region]
    if self[:region].nil?
      raise ArgumentError, "Missing required EndpointParameter: :region"
    end
    self[:endpoint] = options[:endpoint]
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:service_type] = options[:service_type]
    if self[:service_type].nil?
      raise ArgumentError, "Missing required EndpointParameter: :service_type"
    end
  end

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

#service_type ⇒ string

The service type: ACM or ACM-ACME. Injected via @staticContextParams.

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
79
80
81
82
83
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 38

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

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

  def initialize(options = {})
    self[:region] = options[:region]
    if self[:region].nil?
      raise ArgumentError, "Missing required EndpointParameter: :region"
    end
    self[:endpoint] = options[:endpoint]
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:service_type] = options[:service_type]
    if self[:service_type].nil?
      raise ArgumentError, "Missing required EndpointParameter: :service_type"
    end
  end

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

#use_dual_stack ⇒ boolean

Use dual-stack endpoints.

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
79
80
81
82
83
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 38

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

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

  def initialize(options = {})
    self[:region] = options[:region]
    if self[:region].nil?
      raise ArgumentError, "Missing required EndpointParameter: :region"
    end
    self[:endpoint] = options[:endpoint]
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:service_type] = options[:service_type]
    if self[:service_type].nil?
      raise ArgumentError, "Missing required EndpointParameter: :service_type"
    end
  end

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

#use_fips ⇒ boolean

Use FIPS endpoints.

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
79
80
81
82
83
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 38

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

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

  def initialize(options = {})
    self[:region] = options[:region]
    if self[:region].nil?
      raise ArgumentError, "Missing required EndpointParameter: :region"
    end
    self[:endpoint] = options[:endpoint]
    self[:use_fips] = options[:use_fips]
    self[:use_fips] = false if self[:use_fips].nil?
    self[:use_dual_stack] = options[:use_dual_stack]
    self[:use_dual_stack] = false if self[:use_dual_stack].nil?
    self[:service_type] = options[:service_type]
    if self[:service_type].nil?
      raise ArgumentError, "Missing required EndpointParameter: :service_type"
    end
  end

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

Class Method Details

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



74
75
76
77
78
79
80
81
82
 
# File 'lib/aws-sdk-acm/endpoint_parameters.rb', line 74

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