Class: Aws::Kinesis::EndpointParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/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,
  'StreamId' => :stream_id,
  'StreamARN' => :stream_arn,
  'OperationType' => :operation_type,
  'ConsumerARN' => :consumer_arn,
  'ResourceARN' => :resource_arn,
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 86

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[:stream_id] = options[:stream_id]
  self[:stream_arn] = options[:stream_arn]
  self[:operation_type] = options[:operation_type]
  self[:consumer_arn] = options[:consumer_arn]
  self[:resource_arn] = options[:resource_arn]
end

Instance Attribute Details

#consumer_arn ⇒ string

The ARN of the Kinesis consumer

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#endpoint ⇒ string

Override the endpoint used to send this request

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#operation_type ⇒ string

Internal parameter to distinguish between Control/Data plane API and accordingly generate control/data plane endpoint

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#region ⇒ string

The AWS region used to dispatch the request.

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#resource_arn ⇒ string

The ARN of the Kinesis resource

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#stream_arn ⇒ string

The ARN of the Kinesis stream

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

#stream_id ⇒ string

The unique identifier of the Kinesis stream

Returns:

  • (string) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.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) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.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) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 58

EndpointParameters = Struct.new(
  :region,
  :use_dual_stack,
  :use_fips,
  :endpoint,
  :stream_id,
  :stream_arn,
  :operation_type,
  :consumer_arn,
  :resource_arn,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseDualStack' => :use_dual_stack,
      'UseFIPS' => :use_fips,
      'Endpoint' => :endpoint,
      'StreamId' => :stream_id,
      'StreamARN' => :stream_arn,
      'OperationType' => :operation_type,
      'ConsumerARN' => :consumer_arn,
      'ResourceARN' => :resource_arn,
    }.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[:stream_id] = options[:stream_id]
    self[:stream_arn] = options[:stream_arn]
    self[:operation_type] = options[:operation_type]
    self[:consumer_arn] = options[:consumer_arn]
    self[:resource_arn] = options[:resource_arn]
  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),
    }.merge(options))
  end
end

Class Method Details

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



100
101
102
103
104
105
106
107
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/endpoint_parameters.rb', line 100

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),
  }.merge(options))
end