Struct Params

#[non_exhaustive]
pub struct Params { /* private fields */ }

Configuration parameters for resolving the correct endpoint

Implementations

impl Params

pub fn builder() -> ParamsBuilder

Create a builder for Params

pub fn bucket(&self) -> Option<&str>

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) -> Option<&str>

The AWS region used to dispatch the request.

pub fn use_fips(&self) -> Option<bool>

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) -> Option<bool>

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) -> Option<&str>

Override the endpoint used to send this request

pub fn force_path_style(&self) -> Option<bool>

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

pub fn accelerate(&self) -> Option<bool>

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

pub fn use_global_endpoint(&self) -> Option<bool>

Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

pub fn use_object_lambda_endpoint(&self) -> Option<bool>

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

pub fn key(&self) -> Option<&str>

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) -> Option<&str>

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 copy_source(&self) -> Option<&str>

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.

pub fn disable_access_points(&self) -> Option<bool>

Internal parameter to disable Access Point Buckets

pub fn disable_multi_region_access_points(&self) -> Option<bool>

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

pub fn use_arn_region(&self) -> Option<bool>

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) -> Option<bool>

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

pub fn disable_s3_express_session_auth(&self) -> Option<bool>

Parameter to indicate whether S3Express session auth should be disabled

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl PartialEq for Params

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Params