Class: Aws::EventBridgeV2::EndpointParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/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,
  'AccountId' => :account_id,
  'EventBusArn' => :event_bus_arn,
  'AccountIdEndpointMode' => :account_id_endpoint_mode,
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 72

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[:account_id] = options[:account_id]
  self[:event_bus_arn] = options[:event_bus_arn]
  self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
end

Instance Attribute Details

#account_id ⇒ String

The AWS account ID used for the request, sourced from the caller's credentials.

Returns:

  • (String) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#account_id_endpoint_mode ⇒ String

The behavior for account ID based endpoint routing: preferred, disabled, or required.

Returns:

  • (String) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#endpoint ⇒ String

Override the endpoint used to send this request.

Returns:

  • (String) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#event_bus_arn ⇒ String

The bus ARN from the request, bound via @contextParam. Its account is the bus owner and takes precedence over the credentials-sourced account for cell routing (cross-account calls).

Returns:

  • (String) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#region ⇒ String

The AWS region used to dispatch the request.

Returns:

  • (String) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#use_dual_stack ⇒ Boolean

When true, use the dual-stack endpoint.

Returns:

  • (Boolean) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

#use_fips ⇒ Boolean

When true, send this request to the FIPS-compliant regional endpoint.

Returns:

  • (Boolean) 


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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/endpoint_parameters.rb', line 48

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

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'Endpoint' => :endpoint,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'AccountId' => :account_id,
      'EventBusArn' => :event_bus_arn,
      'AccountIdEndpointMode' => :account_id_endpoint_mode,
    }.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[:account_id] = options[:account_id]
    self[:event_bus_arn] = options[:event_bus_arn]
    self[:account_id_endpoint_mode] = options[:account_id_endpoint_mode]
  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,
      account_id: config.credentials.credentials.,
      account_id_endpoint_mode: config.,
    }.merge(options))
  end
end

Class Method Details

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



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

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,
    account_id: config.credentials.credentials.,
    account_id_endpoint_mode: config.,
  }.merge(options))
end