Interface S3AuthSchemeParams.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
,SdkBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
- Enclosing interface:
- S3AuthSchemeParams
public static interface S3AuthSchemeParams.Builder extends CopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
A builder for aS3AuthSchemeParams
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description S3AuthSchemeParams.Builder
accelerate(Boolean accelerate)
When true, use S3 Accelerate.S3AuthSchemeParams.Builder
bucket(String bucket)
The S3 bucket used to send the request.S3AuthSchemeParams
build()
Returns aS3AuthSchemeParams
object that is created from the properties that have been set on the builder.S3AuthSchemeParams.Builder
copySource(String copySource)
The Copy Source used for Copy Object request.S3AuthSchemeParams.Builder
deleteObjectKeys(List<String> deleteObjectKeys)
DeleteObjectKeys Endpoint Params from the customization configS3AuthSchemeParams.Builder
disableAccessPoints(Boolean disableAccessPoints)
Internal parameter to disable Access Point BucketsS3AuthSchemeParams.Builder
disableMultiRegionAccessPoints(Boolean disableMultiRegionAccessPoints)
Whether multi-region access points (MRAP) should be disabled.S3AuthSchemeParams.Builder
disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)
Parameter to indicate whether S3Express session auth should be disabledS3AuthSchemeParams.Builder
endpoint(String endpoint)
Override the endpoint used to send this requestS3AuthSchemeParams.Builder
forcePathStyle(Boolean forcePathStyle)
When true, force a path-style endpoint to be used where the bucket name is part of the path.S3AuthSchemeParams.Builder
key(String key)
The S3 Key used to send the request.S3AuthSchemeParams.Builder
operation(String operation)
Set the operation for which to resolve the auth scheme.S3AuthSchemeParams.Builder
prefix(String prefix)
The S3 Prefix used to send the request.S3AuthSchemeParams.Builder
region(Region region)
Set the region.S3AuthSchemeParams.Builder
useArnRegion(Boolean useArnRegion)
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.S3AuthSchemeParams.Builder
useDualStack(Boolean useDualStack)
When true, use the dual-stack endpoint.S3AuthSchemeParams.Builder
useFips(Boolean useFIPS)
When true, send this request to the FIPS-compliant regional endpoint.S3AuthSchemeParams.Builder
useGlobalEndpoint(Boolean useGlobalEndpoint)
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.S3AuthSchemeParams.Builder
useObjectLambdaEndpoint(Boolean useObjectLambdaEndpoint)
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)S3AuthSchemeParams.Builder
useS3ExpressControlEndpoint(Boolean useS3ExpressControlEndpoint)
Internal parameter to indicate whether S3Express operation should use control plane, (ex.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation
-
-
-
-
Method Detail
-
operation
S3AuthSchemeParams.Builder operation(String operation)
Set the operation for which to resolve the auth scheme.
-
region
S3AuthSchemeParams.Builder region(Region region)
Set the region. The region parameter may be used with the "aws.auth#sigv4" auth scheme.
-
bucket
S3AuthSchemeParams.Builder bucket(String 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.
-
useFips
S3AuthSchemeParams.Builder useFips(Boolean useFIPS)
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.
-
useDualStack
S3AuthSchemeParams.Builder useDualStack(Boolean useDualStack)
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
-
endpoint
S3AuthSchemeParams.Builder endpoint(String endpoint)
Override the endpoint used to send this request
-
forcePathStyle
S3AuthSchemeParams.Builder forcePathStyle(Boolean forcePathStyle)
When true, force a path-style endpoint to be used where the bucket name is part of the path.
-
accelerate
S3AuthSchemeParams.Builder accelerate(Boolean accelerate)
When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.
-
useGlobalEndpoint
S3AuthSchemeParams.Builder useGlobalEndpoint(Boolean useGlobalEndpoint)
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
-
useObjectLambdaEndpoint
S3AuthSchemeParams.Builder useObjectLambdaEndpoint(Boolean useObjectLambdaEndpoint)
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
-
key
S3AuthSchemeParams.Builder key(String 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.
-
prefix
S3AuthSchemeParams.Builder prefix(String 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.
-
copySource
S3AuthSchemeParams.Builder copySource(String copySource)
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.
-
disableAccessPoints
S3AuthSchemeParams.Builder disableAccessPoints(Boolean disableAccessPoints)
Internal parameter to disable Access Point Buckets
-
disableMultiRegionAccessPoints
S3AuthSchemeParams.Builder disableMultiRegionAccessPoints(Boolean disableMultiRegionAccessPoints)
Whether multi-region access points (MRAP) should be disabled.
-
useArnRegion
S3AuthSchemeParams.Builder useArnRegion(Boolean useArnRegion)
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.
-
useS3ExpressControlEndpoint
S3AuthSchemeParams.Builder useS3ExpressControlEndpoint(Boolean useS3ExpressControlEndpoint)
Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)
-
disableS3ExpressSessionAuth
S3AuthSchemeParams.Builder disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)
Parameter to indicate whether S3Express session auth should be disabled
-
deleteObjectKeys
S3AuthSchemeParams.Builder deleteObjectKeys(List<String> deleteObjectKeys)
DeleteObjectKeys Endpoint Params from the customization config
-
build
S3AuthSchemeParams build()
Returns aS3AuthSchemeParams
object that is created from the properties that have been set on the builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
-
-