@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WorkGroupConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the
encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the
workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data
scanned per query or per workgroup. The workgroup settings override is specified in
EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
Constructor and Description |
---|
WorkGroupConfiguration() |
Modifier and Type | Method and Description |
---|---|
WorkGroupConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getAdditionalConfiguration()
Specifies a user defined JSON string that is passed to the notebook engine.
|
Long |
getBytesScannedCutoffPerQuery()
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
|
CustomerContentEncryptionConfiguration |
getCustomerContentEncryptionConfiguration()
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
|
Boolean |
getEnforceWorkGroupConfiguration()
If set to "true", the settings for the workgroup override client-side settings.
|
EngineVersion |
getEngineVersion()
The engine version that all queries running on the workgroup use.
|
String |
getExecutionRole()
Role used in a notebook session for accessing the user's resources.
|
Boolean |
getPublishCloudWatchMetricsEnabled()
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
|
Boolean |
getRequesterPaysEnabled()
If set to
true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. |
ResultConfiguration |
getResultConfiguration()
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and
the encryption option, if any, used for query results.
|
int |
hashCode() |
Boolean |
isEnforceWorkGroupConfiguration()
If set to "true", the settings for the workgroup override client-side settings.
|
Boolean |
isPublishCloudWatchMetricsEnabled()
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
|
Boolean |
isRequesterPaysEnabled()
If set to
true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalConfiguration(String additionalConfiguration)
Specifies a user defined JSON string that is passed to the notebook engine.
|
void |
setBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
|
void |
setCustomerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
|
void |
setEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
If set to "true", the settings for the workgroup override client-side settings.
|
void |
setEngineVersion(EngineVersion engineVersion)
The engine version that all queries running on the workgroup use.
|
void |
setExecutionRole(String executionRole)
Role used in a notebook session for accessing the user's resources.
|
void |
setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
|
void |
setRequesterPaysEnabled(Boolean requesterPaysEnabled)
If set to
true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. |
void |
setResultConfiguration(ResultConfiguration resultConfiguration)
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and
the encryption option, if any, used for query results.
|
String |
toString()
Returns a string representation of this object.
|
WorkGroupConfiguration |
withAdditionalConfiguration(String additionalConfiguration)
Specifies a user defined JSON string that is passed to the notebook engine.
|
WorkGroupConfiguration |
withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
|
WorkGroupConfiguration |
withCustomerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
|
WorkGroupConfiguration |
withEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
If set to "true", the settings for the workgroup override client-side settings.
|
WorkGroupConfiguration |
withEngineVersion(EngineVersion engineVersion)
The engine version that all queries running on the workgroup use.
|
WorkGroupConfiguration |
withExecutionRole(String executionRole)
Role used in a notebook session for accessing the user's resources.
|
WorkGroupConfiguration |
withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
|
WorkGroupConfiguration |
withRequesterPaysEnabled(Boolean requesterPaysEnabled)
If set to
true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. |
WorkGroupConfiguration |
withResultConfiguration(ResultConfiguration resultConfiguration)
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and
the encryption option, if any, used for query results.
|
public void setResultConfiguration(ResultConfiguration resultConfiguration)
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
resultConfiguration
- The configuration for the workgroup, which includes the location in Amazon S3 where query results are
stored and the encryption option, if any, used for query results. To run the query, you must specify the
query results location using one of the ways: either in the workgroup using this setting, or for
individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set,
Athena issues an error that no output location is provided. For more information, see Query Results.public ResultConfiguration getResultConfiguration()
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
public WorkGroupConfiguration withResultConfiguration(ResultConfiguration resultConfiguration)
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
resultConfiguration
- The configuration for the workgroup, which includes the location in Amazon S3 where query results are
stored and the encryption option, if any, used for query results. To run the query, you must specify the
query results location using one of the ways: either in the workgroup using this setting, or for
individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set,
Athena issues an error that no output location is provided. For more information, see Query Results.public void setEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
enforceWorkGroupConfiguration
- If set to "true", the settings for the workgroup override client-side settings. If set to "false",
client-side settings are used. For more information, see Workgroup Settings
Override Client-Side Settings.public Boolean getEnforceWorkGroupConfiguration()
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
public WorkGroupConfiguration withEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
enforceWorkGroupConfiguration
- If set to "true", the settings for the workgroup override client-side settings. If set to "false",
client-side settings are used. For more information, see Workgroup Settings
Override Client-Side Settings.public Boolean isEnforceWorkGroupConfiguration()
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
public void setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
publishCloudWatchMetricsEnabled
- Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.public Boolean getPublishCloudWatchMetricsEnabled()
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
public WorkGroupConfiguration withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
publishCloudWatchMetricsEnabled
- Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.public Boolean isPublishCloudWatchMetricsEnabled()
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
public void setBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
bytesScannedCutoffPerQuery
- The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to
scan.public Long getBytesScannedCutoffPerQuery()
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
public WorkGroupConfiguration withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
bytesScannedCutoffPerQuery
- The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to
scan.public void setRequesterPaysEnabled(Boolean requesterPaysEnabled)
If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
requesterPaysEnabled
- If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays
buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays
buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is
false
. For more information about Requester Pays buckets, see Requester Pays
Buckets in the Amazon Simple Storage Service Developer Guide.public Boolean getRequesterPaysEnabled()
If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays
buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays
buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is
false
. For more information about Requester Pays buckets, see Requester Pays
Buckets in the Amazon Simple Storage Service Developer Guide.public WorkGroupConfiguration withRequesterPaysEnabled(Boolean requesterPaysEnabled)
If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
requesterPaysEnabled
- If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays
buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays
buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is
false
. For more information about Requester Pays buckets, see Requester Pays
Buckets in the Amazon Simple Storage Service Developer Guide.public Boolean isRequesterPaysEnabled()
If set to true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays
buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays
buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is
false
. For more information about Requester Pays buckets, see Requester Pays
Buckets in the Amazon Simple Storage Service Developer Guide.public void setEngineVersion(EngineVersion engineVersion)
The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting.
engineVersion
- The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this
setting.public EngineVersion getEngineVersion()
The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting.
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this
setting.public WorkGroupConfiguration withEngineVersion(EngineVersion engineVersion)
The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this setting.
engineVersion
- The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality
workgroup run on the preview engine regardless of this
setting.public void setAdditionalConfiguration(String additionalConfiguration)
Specifies a user defined JSON string that is passed to the notebook engine.
additionalConfiguration
- Specifies a user defined JSON string that is passed to the notebook engine.public String getAdditionalConfiguration()
Specifies a user defined JSON string that is passed to the notebook engine.
public WorkGroupConfiguration withAdditionalConfiguration(String additionalConfiguration)
Specifies a user defined JSON string that is passed to the notebook engine.
additionalConfiguration
- Specifies a user defined JSON string that is passed to the notebook engine.public void setExecutionRole(String executionRole)
Role used in a notebook session for accessing the user's resources.
executionRole
- Role used in a notebook session for accessing the user's resources.public String getExecutionRole()
Role used in a notebook session for accessing the user's resources.
public WorkGroupConfiguration withExecutionRole(String executionRole)
Role used in a notebook session for accessing the user's resources.
executionRole
- Role used in a notebook session for accessing the user's resources.public void setCustomerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
customerContentEncryptionConfiguration
- Specifies the KMS key that is used to encrypt the user's data stores in Athena.public CustomerContentEncryptionConfiguration getCustomerContentEncryptionConfiguration()
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
public WorkGroupConfiguration withCustomerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
customerContentEncryptionConfiguration
- Specifies the KMS key that is used to encrypt the user's data stores in Athena.public String toString()
toString
in class Object
Object.toString()
public WorkGroupConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.