Class CfnWorkGroup.ResultConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.athena.CfnWorkGroup.ResultConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkGroup.ResultConfigurationProperty>
- Enclosing interface:
- CfnWorkGroup.ResultConfigurationProperty
@Stability(Stable)
public static final class CfnWorkGroup.ResultConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkGroup.ResultConfigurationProperty>
A builder for
CfnWorkGroup.ResultConfigurationProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaclConfiguration
(IResolvable aclConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getAclConfiguration()
aclConfiguration
(CfnWorkGroup.AclConfigurationProperty aclConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getAclConfiguration()
build()
Builds the configured instance.encryptionConfiguration
(IResolvable encryptionConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getEncryptionConfiguration()
encryptionConfiguration
(CfnWorkGroup.EncryptionConfigurationProperty encryptionConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getEncryptionConfiguration()
expectedBucketOwner
(String expectedBucketOwner) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getExpectedBucketOwner()
outputLocation
(String outputLocation) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getOutputLocation()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aclConfiguration
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder aclConfiguration(IResolvable aclConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getAclConfiguration()
- 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 isBUCKET_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. SeeEnforceWorkGroupConfiguration
.- Returns:
this
-
aclConfiguration
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder aclConfiguration(CfnWorkGroup.AclConfigurationProperty aclConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getAclConfiguration()
- 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 isBUCKET_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. SeeEnforceWorkGroupConfiguration
.- Returns:
this
-
encryptionConfiguration
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder encryptionConfiguration(IResolvable encryptionConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getEncryptionConfiguration()
- Parameters:
encryptionConfiguration
- If query results are encrypted in Amazon S3, indicates the encryption option used (for example,SSE_KMS
orCSE_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. SeeEnforceWorkGroupConfiguration
and Workgroup Settings Override Client-Side Settings .- Returns:
this
-
encryptionConfiguration
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder encryptionConfiguration(CfnWorkGroup.EncryptionConfigurationProperty encryptionConfiguration) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getEncryptionConfiguration()
- Parameters:
encryptionConfiguration
- If query results are encrypted in Amazon S3, indicates the encryption option used (for example,SSE_KMS
orCSE_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. SeeEnforceWorkGroupConfiguration
and Workgroup Settings Override Client-Side Settings .- Returns:
this
-
expectedBucketOwner
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder expectedBucketOwner(String expectedBucketOwner) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getExpectedBucketOwner()
- Parameters:
expectedBucketOwner
- The account ID that you expect to be the owner of the Amazon S3 bucket specified byResultConfiguration:OutputLocation
. If set, Athena uses the value forExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwner
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. SeeEnforceWorkGroupConfiguration
.- Returns:
this
-
outputLocation
@Stability(Stable) public CfnWorkGroup.ResultConfigurationProperty.Builder outputLocation(String outputLocation) Sets the value ofCfnWorkGroup.ResultConfigurationProperty.getOutputLocation()
- Parameters:
outputLocation
- The location in Amazon S3 where your query results are stored, such ass3://path/to/query/bucket/
. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Working with Query Results, Output Files, and Query History andEnforceWorkGroupConfiguration
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWorkGroup.ResultConfigurationProperty>
- Returns:
- a new instance of
CfnWorkGroup.ResultConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-