Class: Aws::S3::EndpointParameters

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

Overview

Endpoint parameters used to influence endpoints per request.

Constant Summary collapse

PARAM_MAP = 
{
  'Bucket' => :bucket,
  'Region' => :region,
  'UseFIPS' => :use_fips,
  'UseDualStack' => :use_dual_stack,
  'Endpoint' => :endpoint,
  'ForcePathStyle' => :force_path_style,
  'Accelerate' => :accelerate,
  'UseGlobalEndpoint' => :use_global_endpoint,
  'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
  'Key' => :key,
  'Prefix' => :prefix,
  'CopySource' => :copy_source,
  'DisableAccessPoints' => :disable_access_points,
  'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
  'UseArnRegion' => :use_arn_region,
  'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
  'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ EndpointParameters

Returns a new instance of EndpointParameters.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 142

def initialize(options = {})
  self[:bucket] = options[:bucket]
  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[:force_path_style] = options[:force_path_style]
  self[:force_path_style] = false if self[:force_path_style].nil?
  self[:accelerate] = options[:accelerate]
  self[:accelerate] = false if self[:accelerate].nil?
  self[:use_global_endpoint] = options[:use_global_endpoint]
  self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
  self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
  self[:key] = options[:key]
  self[:prefix] = options[:prefix]
  self[:copy_source] = options[:copy_source]
  self[:disable_access_points] = options[:disable_access_points]
  self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
  self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
  self[:use_arn_region] = options[:use_arn_region]
  self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
  self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
end

Instance Attribute Details

#accelerate ⇒ Boolean

When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.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) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#copy_source ⇒ String

The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source.

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#disable_access_points ⇒ Boolean

Internal parameter to disable Access Point Buckets

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#disable_multi_region_access_points ⇒ Boolean

Whether multi-region access points (MRAP) should be disabled.

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#disable_s3_express_session_auth ⇒ Boolean

Parameter to indicate whether S3Express session auth should be disabled

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#endpoint ⇒ String

Override the endpoint used to send this request

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#force_path_style ⇒ Boolean

When true, force a path-style endpoint to be used where the bucket name is part of the path.

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#key ⇒ String

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

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#prefix ⇒ String

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

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#region ⇒ String

The AWS region used to dispatch the request.

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.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) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.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) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.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) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.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) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#use_object_lambda_endpoint ⇒ Boolean

Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

#use_s3_express_control_endpoint ⇒ Boolean

Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 98

EndpointParameters = Struct.new(
  :bucket,
  :region,
  :use_fips,
  :use_dual_stack,
  :endpoint,
  :force_path_style,
  :accelerate,
  :use_global_endpoint,
  :use_object_lambda_endpoint,
  :key,
  :prefix,
  :copy_source,
  :disable_access_points,
  :disable_multi_region_access_points,
  :use_arn_region,
  :use_s3_express_control_endpoint,
  :disable_s3_express_session_auth,
) do
  include Aws::Structure

  # @api private
  class << self
    PARAM_MAP = {
      'Bucket' => :bucket,
      'Region' => :region,
      'UseFIPS' => :use_fips,
      'UseDualStack' => :use_dual_stack,
      'Endpoint' => :endpoint,
      'ForcePathStyle' => :force_path_style,
      'Accelerate' => :accelerate,
      'UseGlobalEndpoint' => :use_global_endpoint,
      'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
      'Key' => :key,
      'Prefix' => :prefix,
      'CopySource' => :copy_source,
      'DisableAccessPoints' => :disable_access_points,
      'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
      'UseArnRegion' => :use_arn_region,
      'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
      'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
    }.freeze
  end

  def initialize(options = {})
    self[:bucket] = options[:bucket]
    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[:force_path_style] = options[:force_path_style]
    self[:force_path_style] = false if self[:force_path_style].nil?
    self[:accelerate] = options[:accelerate]
    self[:accelerate] = false if self[:accelerate].nil?
    self[:use_global_endpoint] = options[:use_global_endpoint]
    self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
    self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
    self[:key] = options[:key]
    self[:prefix] = options[:prefix]
    self[:copy_source] = options[:copy_source]
    self[:disable_access_points] = options[:disable_access_points]
    self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
    self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
    self[:use_arn_region] = options[:use_arn_region]
    self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
    self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
  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),
      force_path_style: config.force_path_style,
      use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
      disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
      use_arn_region: config.s3_use_arn_region,
      disable_s3_express_session_auth: config.disable_s3_express_session_auth,
    }.merge(options))
  end
end

Class Method Details

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



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 168

def self.create(config, options={})
  new({
    region: config.region,
    use_fips: config.use_fips_endpoint,
    endpoint: (config.endpoint.to_s unless config.regional_endpoint),
    force_path_style: config.force_path_style,
    use_global_endpoint: config.s3_us_east_1_regional_endpoint == 'legacy',
    disable_multi_region_access_points: config.s3_disable_multiregion_access_points,
    use_arn_region: config.s3_use_arn_region,
    disable_s3_express_session_auth: config.disable_s3_express_session_auth,
  }.merge(options))
end