Class: Aws::S3::EndpointParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::EndpointParameters
- 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze
Instance Attribute Summary collapse
-
#accelerate ⇒ Boolean
When true, use S3 Accelerate.
-
#bucket ⇒ String
The S3 bucket used to send the request.
-
#disable_access_points ⇒ Boolean
Internal parameter to disable Access Point Buckets.
-
#disable_multi_region_access_points ⇒ Boolean
Whether multi-region access points (MRAP) should be disabled.
-
#endpoint ⇒ String
Override the endpoint used to send this request.
-
#force_path_style ⇒ Boolean
When true, force a path-style endpoint to be used where the bucket name is part of the path.
-
#region ⇒ String
The AWS region used to dispatch the request.
-
#use_arn_region ⇒ Boolean
When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.
-
#use_dual_stack ⇒ Boolean
When true, use the dual-stack endpoint.
-
#use_fips ⇒ Boolean
When true, send this request to the FIPS-compliant regional endpoint.
-
#use_global_endpoint ⇒ Boolean
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
-
#use_object_lambda_endpoint ⇒ Boolean
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse).
Instance Method Summary collapse
-
#initialize(options = {}) ⇒ EndpointParameters
constructor
A new instance of EndpointParameters.
Constructor Details
#initialize(options = {}) ⇒ EndpointParameters
Returns a new instance of EndpointParameters.
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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 107 def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end |
Instance Attribute Details
#accelerate ⇒ Boolean
When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] 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.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#disable_access_points ⇒ Boolean
Internal parameter to disable Access Point Buckets
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#disable_multi_region_access_points ⇒ Boolean
Whether multi-region access points (MRAP) should be disabled.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#endpoint ⇒ String
Override the endpoint used to send this request
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] 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.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#region ⇒ String
The AWS region used to dispatch the request.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#use_arn_region ⇒ Boolean
When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] 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.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] 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.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#use_global_endpoint ⇒ Boolean
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |
#use_object_lambda_endpoint ⇒ Boolean
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
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 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 |
# File 'lib/aws-sdk-s3/endpoint_parameters.rb', line 73 EndpointParameters = Struct.new( :bucket, :region, :use_fips, :use_dual_stack, :endpoint, :force_path_style, :accelerate, :use_global_endpoint, :use_object_lambda_endpoint, :disable_access_points, :disable_multi_region_access_points, :use_arn_region, ) 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, 'DisableAccessPoints' => :disable_access_points, 'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points, 'UseArnRegion' => :use_arn_region, }.freeze end def initialize( = {}) self[:bucket] = [:bucket] self[:region] = [:region] self[:use_fips] = [:use_fips] self[:use_fips] = false if self[:use_fips].nil? if self[:use_fips].nil? raise ArgumentError, "Missing required EndpointParameter: :use_fips" end self[:use_dual_stack] = [:use_dual_stack] self[:use_dual_stack] = false if self[:use_dual_stack].nil? if self[:use_dual_stack].nil? raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack" end self[:endpoint] = [:endpoint] self[:force_path_style] = [:force_path_style] self[:accelerate] = [:accelerate] self[:accelerate] = false if self[:accelerate].nil? if self[:accelerate].nil? raise ArgumentError, "Missing required EndpointParameter: :accelerate" end self[:use_global_endpoint] = [:use_global_endpoint] self[:use_global_endpoint] = false if self[:use_global_endpoint].nil? if self[:use_global_endpoint].nil? raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint" end self[:use_object_lambda_endpoint] = [:use_object_lambda_endpoint] self[:disable_access_points] = [:disable_access_points] self[:disable_multi_region_access_points] = [:disable_multi_region_access_points] self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil? if self[:disable_multi_region_access_points].nil? raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points" end self[:use_arn_region] = [:use_arn_region] end end |