com.ibm.cos.v2.services.s3.presigner

Interface S3Presigner.Builder

All Superinterfaces:

SdkPresigner.Builder

All Known Implementing Classes:

DefaultS3Presigner.Builder

Enclosing interface:

S3Presigner

@NotThreadSafe
public static interface S3Presigner.Builder
extends SdkPresigner.Builder

A builder for creating S3Presigners. Created using S3Presigner.builder().

Method Summary

Modifier and Type	Method and Description
S3Presigner	build() Build the presigner using the configuration on this builder.
default S3Presigner.Builder	credentialsProvider(AwsCredentialsProvider credentialsProvider) Configure the credentials that should be used for request signing.
S3Presigner.Builder	credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider) Configure the credentials that should be used to authenticate with AWS.
S3Presigner.Builder	disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth) Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name.
S3Presigner.Builder	dualstackEnabled(Boolean dualstackEnabled) Configure whether the SDK should use the AWS dualstack endpoint.
S3Presigner.Builder	endpointOverride(URI endpointOverride) Configure an endpoint that should be used in the pre-signed requests.
S3Presigner.Builder	fipsEnabled(Boolean fipsEnabled) Configure whether the SDK should use the AWS fips endpoint.
S3Presigner.Builder	region(Region region) Configure the region for which the requests should be signed.
S3Presigner.Builder	s3Client(S3Client s3Client) Supply an S3 client for presigning S3 express requests that require S3 express session credentials, S3ExpressSessionCredentials.
S3Presigner.Builder	serviceConfiguration(S3Configuration serviceConfiguration) Allows providing a custom S3 serviceConfiguration by providing a S3Configuration object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.

Method Detail

serviceConfiguration

S3Presigner.Builder serviceConfiguration(S3Configuration serviceConfiguration)

Allows providing a custom S3 serviceConfiguration by providing a S3Configuration object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.

Parameters:

serviceConfiguration - S3Configuration

Returns:

this Builder

disableS3ExpressSessionAuth

S3Presigner.Builder disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)

Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name. This value is by default false, which means that S3ExpressSessionCredentials will be used for presigning the request if an s3Client(S3Client) is also configured on the presigner.

Note: If this option and s3Client(S3Client) is not configured, S3 express presigning works, but session auth will be disabled

Parameters:

disableS3ExpressSessionAuth - - whether to disable S3 express session auth or not

Returns:

this Builder

s3Client

S3Presigner.Builder s3Client(S3Client s3Client)

Supply an S3 client for presigning S3 express requests that require S3 express session credentials, S3ExpressSessionCredentials. These session credentials are short-lived. If the client isn't supplied, a presigned request targeting an S3 express bucket will use standard Sigv4 credentials for signing. This results in the same behavior as disabling S3 session auth using disableS3ExpressSessionAuth(Boolean).

Note: If this option and disableS3ExpressSessionAuth(Boolean) is not configured, S3 express presigning works, but session auth will be disabled

Parameters:

s3Client - S3Client

Returns:

this Builder

region

S3Presigner.Builder region(Region region)

Description copied from interface: SdkPresigner.Builder

Configure the region for which the requests should be signed.

If this is not specified, the SDK will attempt to identify the endpoint automatically using the following logic:

1. Check the 'aws.region' system property for the region.
2. Check the 'AWS_REGION' environment variable for the region.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the region.
4. If running in EC2, check the EC2 metadata service for the region.

If the region is not found in any of the locations above, an exception will be thrown at SdkPresigner.Builder.build() time.

Specified by:

region in interface SdkPresigner.Builder

credentialsProvider

default S3Presigner.Builder credentialsProvider(AwsCredentialsProvider credentialsProvider)

Description copied from interface: SdkPresigner.Builder

Configure the credentials that should be used for request signing.

The default provider will attempt to identify the credentials automatically using the following checks:

1. Java System Properties - aws.accessKeyId and aws.secretAccessKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.
5. Instance profile credentials delivered through the Amazon EC2 metadata service

If the credentials are not found in any of the locations above, an exception will be thrown at SdkPresigner.Builder.build() time.

The last of SdkPresigner.Builder.credentialsProvider(AwsCredentialsProvider) or SdkPresigner.Builder.credentialsProvider(IdentityProvider) wins.

Specified by:

credentialsProvider in interface SdkPresigner.Builder

credentialsProvider

S3Presigner.Builder credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider)

Description copied from interface: SdkPresigner.Builder

Configure the credentials that should be used to authenticate with AWS.

The default provider will attempt to identify the credentials automatically using the following checks:

1. Java System Properties - aws.accessKeyId and aws.secretAccessKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.
5. Instance profile credentials delivered through the Amazon EC2 metadata service

If the credentials are not found in any of the locations above, an exception will be thrown at SdkPresigner.Builder.build() time.

The last of SdkPresigner.Builder.credentialsProvider(AwsCredentialsProvider) or SdkPresigner.Builder.credentialsProvider(IdentityProvider) wins.

Specified by:

credentialsProvider in interface SdkPresigner.Builder

dualstackEnabled

S3Presigner.Builder dualstackEnabled(Boolean dualstackEnabled)

Description copied from interface: SdkPresigner.Builder

Configure whether the SDK should use the AWS dualstack endpoint.

If this is not specified, the SDK will attempt to determine whether the dualstack endpoint should be used automatically using the following logic:

1. Check the 'aws.useDualstackEndpoint' system property for 'true' or 'false'.
2. Check the 'AWS_USE_DUALSTACK_ENDPOINT' environment variable for 'true' or 'false'.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the 'use_dualstack_endpoint' property set to 'true' or 'false'.

If the setting is not found in any of the locations above, 'false' will be used.

Specified by:

dualstackEnabled in interface SdkPresigner.Builder

fipsEnabled

S3Presigner.Builder fipsEnabled(Boolean fipsEnabled)

Description copied from interface: SdkPresigner.Builder

Configure whether the SDK should use the AWS fips endpoint.

If this is not specified, the SDK will attempt to determine whether the fips endpoint should be used automatically using the following logic:

1. Check the 'aws.useFipsEndpoint' system property for 'true' or 'false'.
2. Check the 'AWS_USE_FIPS_ENDPOINT' environment variable for 'true' or 'false'.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the 'use_fips_endpoint' property set to 'true' or 'false'.

If the setting is not found in any of the locations above, 'false' will be used.

Specified by:

fipsEnabled in interface SdkPresigner.Builder

endpointOverride

S3Presigner.Builder endpointOverride(URI endpointOverride)

Description copied from interface: SdkPresigner.Builder

Configure an endpoint that should be used in the pre-signed requests. This will override the endpoint that is usually determined by the SdkPresigner.Builder.region(Region) and SdkPresigner.Builder.dualstackEnabled(Boolean) settings.

Specified by:

endpointOverride in interface SdkPresigner.Builder

build

S3Presigner build()

Description copied from interface: SdkPresigner.Builder

Build the presigner using the configuration on this builder.

Specified by:

build in interface SdkPresigner.Builder