Class DefaultS3AuthSchemeParams
- java.lang.Object
-
- software.amazon.awssdk.services.s3.auth.scheme.internal.DefaultS3AuthSchemeParams
-
- All Implemented Interfaces:
S3AuthSchemeParams
,ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
@Generated("software.amazon.awssdk:codegen") public final class DefaultS3AuthSchemeParams extends Object implements S3AuthSchemeParams
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
accelerate()
When true, use S3 Accelerate.String
bucket()
The S3 bucket used to send the request.static S3AuthSchemeParams.Builder
builder()
Get a new builder for creating aS3AuthSchemeParams
.Boolean
disableAccessPoints()
Internal parameter to disable Access Point BucketsBoolean
disableMultiRegionAccessPoints()
Whether multi-region access points (MRAP) should be disabled.String
endpoint()
Override the endpoint used to send this requestBoolean
forcePathStyle()
When true, force a path-style endpoint to be used where the bucket name is part of the path.String
operation()
Returns the operation for which to resolve the auth scheme.Region
region()
Returns the region.S3AuthSchemeParams.Builder
toBuilder()
Returns aS3AuthSchemeParams.Builder
to customize the parameters.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.Boolean
useDualStack()
When true, use the dual-stack endpoint.Boolean
useFips()
When true, send this request to the FIPS-compliant regional endpoint.Boolean
useGlobalEndpoint()
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.Boolean
useObjectLambdaEndpoint()
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
builder
public static S3AuthSchemeParams.Builder builder()
Description copied from interface:S3AuthSchemeParams
Get a new builder for creating aS3AuthSchemeParams
.
-
operation
public String operation()
Description copied from interface:S3AuthSchemeParams
Returns the operation for which to resolve the auth scheme.- Specified by:
operation
in interfaceS3AuthSchemeParams
-
region
public Region region()
Description copied from interface:S3AuthSchemeParams
Returns the region. The region parameter may be used with the "aws.auth#sigv4" auth scheme.- Specified by:
region
in interfaceS3AuthSchemeParams
-
bucket
public String bucket()
Description copied from interface:S3AuthSchemeParams
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.- Specified by:
bucket
in interfaceS3AuthSchemeParams
-
useFips
public Boolean useFips()
Description copied from interface:S3AuthSchemeParams
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.- Specified by:
useFips
in interfaceS3AuthSchemeParams
-
useDualStack
public Boolean useDualStack()
Description copied from interface:S3AuthSchemeParams
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.- Specified by:
useDualStack
in interfaceS3AuthSchemeParams
-
endpoint
public String endpoint()
Description copied from interface:S3AuthSchemeParams
Override the endpoint used to send this request- Specified by:
endpoint
in interfaceS3AuthSchemeParams
-
forcePathStyle
public Boolean forcePathStyle()
Description copied from interface:S3AuthSchemeParams
When true, force a path-style endpoint to be used where the bucket name is part of the path.- Specified by:
forcePathStyle
in interfaceS3AuthSchemeParams
-
accelerate
public Boolean accelerate()
Description copied from interface:S3AuthSchemeParams
When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.- Specified by:
accelerate
in interfaceS3AuthSchemeParams
-
useGlobalEndpoint
public Boolean useGlobalEndpoint()
Description copied from interface:S3AuthSchemeParams
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.- Specified by:
useGlobalEndpoint
in interfaceS3AuthSchemeParams
-
useObjectLambdaEndpoint
public Boolean useObjectLambdaEndpoint()
Description copied from interface:S3AuthSchemeParams
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)- Specified by:
useObjectLambdaEndpoint
in interfaceS3AuthSchemeParams
-
disableAccessPoints
public Boolean disableAccessPoints()
Description copied from interface:S3AuthSchemeParams
Internal parameter to disable Access Point Buckets- Specified by:
disableAccessPoints
in interfaceS3AuthSchemeParams
-
disableMultiRegionAccessPoints
public Boolean disableMultiRegionAccessPoints()
Description copied from interface:S3AuthSchemeParams
Whether multi-region access points (MRAP) should be disabled.- Specified by:
disableMultiRegionAccessPoints
in interfaceS3AuthSchemeParams
-
useArnRegion
public Boolean useArnRegion()
Description copied from interface:S3AuthSchemeParams
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.- Specified by:
useArnRegion
in interfaceS3AuthSchemeParams
-
toBuilder
public S3AuthSchemeParams.Builder toBuilder()
Description copied from interface:S3AuthSchemeParams
Returns aS3AuthSchemeParams.Builder
to customize the parameters.- Specified by:
toBuilder
in interfaceS3AuthSchemeParams
- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
-
-