Class: Aws::S3Control::EndpointParameters

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

Overview

Endpoint parameters used to influence endpoints per request.

Constant Summary collapse

PARAM_MAP = 
{
  'Region' => :region,
  'UseFIPS' => :use_fips,
  'UseDualStack' => :use_dual_stack,
  'Endpoint' => :endpoint,
  'AccountId' => :account_id,
  'RequiresAccountId' => :requires_account_id,
  'OutpostId' => :outpost_id,
  'Bucket' => :bucket,
  'AccessPointName' => :access_point_name,
  'UseArnRegion' => :use_arn_region,
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 93

def initialize(options = {})
  self[:region] = options[:region]
  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[:endpoint] = options[:endpoint]
  self[:account_id] = options[:account_id]
  self[:requires_account_id] = options[:requires_account_id]
  self[:outpost_id] = options[:outpost_id]
  self[:bucket] = options[:bucket]
  self[:access_point_name] = options[:access_point_name]
  self[:use_arn_region] = options[:use_arn_region]
end

Instance Attribute Details

#access_point_name ⇒ String

The S3 AccessPointName used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 AccessPoint.

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#account_id ⇒ String

The Account ID used to send the request. This is an optional parameter that will be set automatically for operations that require it.

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#bucket ⇒ String

The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#endpoint ⇒ String

Override the endpoint used to send this request

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#outpost_id ⇒ String

The Outpost ID. Some operations have an optional OutpostId which should be used in endpoint construction.

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#region ⇒ String

The AWS region used to dispatch the request.

Returns:

  • (String) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#requires_account_id ⇒ Boolean

Internal parameter for operations that require account id host prefix.

Returns:

  • (Boolean) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

#use_arn_region ⇒ Boolean

When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN&#39;s region when constructing the endpoint instead of the client&#39;s configured region.

Returns:

  • (Boolean) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_arn_region: config.s3_use_arn_region,
    }.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) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

  def self.create(config, options={})
    new({
      region: config.region,
      use_fips: config.use_fips_endpoint,
      endpoint: (config.endpoint.to_s unless config.regional_endpoint),
      use_arn_region: config.s3_use_arn_region,
    }.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) 


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
109
110
111
112
113
114
115
116
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 63

EndpointParameters = Struct.new(
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :account_id,
  :requires_account_id,
  :outpost_id,
  :bucket,
  :access_point_name,
  :use_arn_region,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'AccountId' => :account_id,
      'RequiresAccountId' => :requires_account_id,
      'OutpostId' => :outpost_id,
      'Bucket' => :bucket,
      'AccessPointName' => :access_point_name,
      'UseArnRegion' => :use_arn_region,
    }.freeze
  end

  def initialize(options = {})
    self[:region] = options[:region]
    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[:endpoint] = options[:endpoint]
    self[:account_id] = options[:account_id]
    self[:requires_account_id] = options[:requires_account_id]
    self[:outpost_id] = options[:outpost_id]
    self[:bucket] = options[:bucket]
    self[:access_point_name] = options[:access_point_name]
    self[:use_arn_region] = options[:use_arn_region]
  end

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

Class Method Details

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



108
109
110
111
112
113
114
115
 
# File 'lib/aws-sdk-s3control/endpoint_parameters.rb', line 108

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