Struct aws_sdk_s3::config::endpoint::ParamsBuilder

pub struct ParamsBuilder { /* private fields */ }

Builder for Params

Implementations

impl ParamsBuilder

pub fn build(self) -> Result<Params, InvalidParams>

Consume this builder, creating Params.

pub fn bucket(self, value: impl Into<String>) -> Self

Sets the value for bucket

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.

pub fn set_bucket(self, param: Option<String>) -> Self

Sets the value for bucket

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.

pub fn region(self, value: impl Into<String>) -> Self

Sets the value for region

The AWS region used to dispatch the request.

pub fn set_region(self, param: Option<String>) -> Self

Sets the value for region

The AWS region used to dispatch the request.

pub fn use_fips(self, value: impl Into<bool>) -> Self

Sets the value for use_fips

When unset, this parameter has a default value of false. 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.

pub fn set_use_fips(self, param: Option<bool>) -> Self

Sets the value for use_fips

When unset, this parameter has a default value of false. 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.

pub fn use_dual_stack(self, value: impl Into<bool>) -> Self

Sets the value for use_dual_stack

When unset, this parameter has a default value of false. When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

pub fn set_use_dual_stack(self, param: Option<bool>) -> Self

Sets the value for use_dual_stack

When unset, this parameter has a default value of false. When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

pub fn endpoint(self, value: impl Into<String>) -> Self

Sets the value for endpoint

Override the endpoint used to send this request

pub fn set_endpoint(self, param: Option<String>) -> Self

Sets the value for endpoint

Override the endpoint used to send this request

pub fn force_path_style(self, value: impl Into<bool>) -> Self

Sets the value for force_path_style

When unset, this parameter has a default value of false. When true, force a path-style endpoint to be used where the bucket name is part of the path.

pub fn set_force_path_style(self, param: Option<bool>) -> Self

Sets the value for force_path_style

When unset, this parameter has a default value of false. When true, force a path-style endpoint to be used where the bucket name is part of the path.

pub fn accelerate(self, value: impl Into<bool>) -> Self

Sets the value for accelerate

When unset, this parameter has a default value of false. When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.

pub fn set_accelerate(self, param: Option<bool>) -> Self

Sets the value for accelerate

When unset, this parameter has a default value of false. When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.

pub fn use_global_endpoint(self, value: impl Into<bool>) -> Self

Sets the value for use_global_endpoint

When unset, this parameter has a default value of false. Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

pub fn set_use_global_endpoint(self, param: Option<bool>) -> Self

Sets the value for use_global_endpoint

When unset, this parameter has a default value of false. Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

pub fn use_object_lambda_endpoint(self, value: impl Into<bool>) -> Self

Sets the value for use_object_lambda_endpoint

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

pub fn set_use_object_lambda_endpoint(self, param: Option<bool>) -> Self

Sets the value for use_object_lambda_endpoint

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

pub fn key(self, value: impl Into<String>) -> Self

Sets the value for key

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.

pub fn set_key(self, param: Option<String>) -> Self

Sets the value for key

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.

pub fn prefix(self, value: impl Into<String>) -> Self

Sets the value for prefix

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.

pub fn set_prefix(self, param: Option<String>) -> Self

Sets the value for prefix

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.

pub fn disable_access_points(self, value: impl Into<bool>) -> Self

Sets the value for disable_access_points

Internal parameter to disable Access Point Buckets

pub fn set_disable_access_points(self, param: Option<bool>) -> Self

Sets the value for disable_access_points

Internal parameter to disable Access Point Buckets

pub fn disable_multi_region_access_points(self, value: impl Into<bool>) -> Self

Sets the value for disable_multi_region_access_points

When unset, this parameter has a default value of false. Whether multi-region access points (MRAP) should be disabled.

pub fn set_disable_multi_region_access_points(self, param: Option<bool>) -> Self

Sets the value for disable_multi_region_access_points

When unset, this parameter has a default value of false. Whether multi-region access points (MRAP) should be disabled.

pub fn use_arn_region(self, value: impl Into<bool>) -> Self

Sets the value for use_arn_region

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.

pub fn set_use_arn_region(self, param: Option<bool>) -> Self

Sets the value for use_arn_region

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.

pub fn use_s3_express_control_endpoint(self, value: impl Into<bool>) -> Self

Sets the value for use_s3_express_control_endpoint

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

pub fn set_use_s3_express_control_endpoint(self, param: Option<bool>) -> Self

Sets the value for use_s3_express_control_endpoint

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

pub fn disable_s3_express_session_auth(self, value: impl Into<bool>) -> Self

Sets the value for disable_s3_express_session_auth

Parameter to indicate whether S3Express session auth should be disabled

pub fn set_disable_s3_express_session_auth(self, param: Option<bool>) -> Self

Sets the value for disable_s3_express_session_auth

Parameter to indicate whether S3Express session auth should be disabled

Trait Implementations

impl Clone for ParamsBuilder

fn clone(&self) -> ParamsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParamsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParamsBuilder

fn default() -> ParamsBuilder

Returns the “default value” for a type.

impl PartialEq for ParamsBuilder

fn eq(&self, other: &ParamsBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParamsBuilder