Package software.amazon.awssdk.services.athena.model

Interface ResultConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ResultConfiguration.Builder,ResultConfiguration>, SdkBuilder<ResultConfiguration.Builder,ResultConfiguration>, SdkPojo

Enclosing class:

ResultConfiguration

public static interface ResultConfiguration.Builder
extends SdkPojo, CopyableBuilder<ResultConfiguration.Builder,ResultConfiguration>

Method Summary

Modifier and Type	Method	Description
default ResultConfiguration.Builder	aclConfiguration(Consumer<AclConfiguration.Builder> aclConfiguration)	Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
ResultConfiguration.Builder	aclConfiguration(AclConfiguration aclConfiguration)	Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
default ResultConfiguration.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.
ResultConfiguration.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.
ResultConfiguration.Builder	expectedBucketOwner(String expectedBucketOwner)	The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.
ResultConfiguration.Builder	outputLocation(String outputLocation)	The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

outputLocation

ResultConfiguration.Builder outputLocation(String outputLocation)

The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Parameters:

outputLocation - The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

ResultConfiguration.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Parameters:

encryptionConfiguration - If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

default ResultConfiguration.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryptionConfiguration(EncryptionConfiguration)

expectedBucketOwner

ResultConfiguration.Builder expectedBucketOwner(String expectedBucketOwner)

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Parameters:

expectedBucketOwner - The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

aclConfiguration

ResultConfiguration.Builder aclConfiguration(AclConfiguration aclConfiguration)

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Parameters:

aclConfiguration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

aclConfiguration

default ResultConfiguration.Builder aclConfiguration(Consumer<AclConfiguration.Builder> aclConfiguration)

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

This is a convenience method that creates an instance of the AclConfiguration.Builder avoiding the need to create one manually via AclConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aclConfiguration(AclConfiguration).

Parameters:

aclConfiguration - a consumer that will call methods on AclConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

aclConfiguration(AclConfiguration)