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

Interface WorkGroupConfigurationUpdates.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>, SdkBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>, SdkPojo
Enclosing class:
WorkGroupConfigurationUpdates
public static interface WorkGroupConfigurationUpdates.Builder extends SdkPojo, CopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>

  • Method Details

    • enforceWorkGroupConfiguration

      WorkGroupConfigurationUpdates.Builder enforceWorkGroupConfiguration(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultConfigurationUpdates

      WorkGroupConfigurationUpdates.Builder resultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)

      The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

      Parameters:
      resultConfigurationUpdates - The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultConfigurationUpdates

      default WorkGroupConfigurationUpdates.Builder resultConfigurationUpdates(Consumer<ResultConfigurationUpdates.Builder> resultConfigurationUpdates)

      The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

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

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

      Parameters:
      resultConfigurationUpdates - a consumer that will call methods on ResultConfigurationUpdates.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • publishCloudWatchMetricsEnabled

      WorkGroupConfigurationUpdates.Builder publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)

      Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

      Parameters:
      publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bytesScannedCutoffPerQuery

      WorkGroupConfigurationUpdates.Builder bytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)

      The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

      Parameters:
      bytesScannedCutoffPerQuery - The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeBytesScannedCutoffPerQuery

      WorkGroupConfigurationUpdates.Builder removeBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)

      Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

      Parameters:
      removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requesterPaysEnabled

      WorkGroupConfigurationUpdates.Builder requesterPaysEnabled(Boolean requesterPaysEnabled)

      If set to true, allows members assigned to a workgroup to specify 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.

      Parameters:
      requesterPaysEnabled - If set to true, allows members assigned to a workgroup to specify 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      WorkGroupConfigurationUpdates.Builder engineVersion(EngineVersion engineVersion)

      The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

      Parameters:
      engineVersion - The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      default WorkGroupConfigurationUpdates.Builder engineVersion(Consumer<EngineVersion.Builder> engineVersion)

      The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

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

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

      Parameters:
      engineVersion - a consumer that will call methods on EngineVersion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • removeCustomerContentEncryptionConfiguration

      WorkGroupConfigurationUpdates.Builder removeCustomerContentEncryptionConfiguration(Boolean removeCustomerContentEncryptionConfiguration)

      Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

      Parameters:
      removeCustomerContentEncryptionConfiguration - Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalConfiguration

      WorkGroupConfigurationUpdates.Builder additionalConfiguration(String additionalConfiguration)

      Contains a user defined string in JSON format for a Spark-enabled workgroup.

      Parameters:
      additionalConfiguration - Contains a user defined string in JSON format for a Spark-enabled workgroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRole

      WorkGroupConfigurationUpdates.Builder executionRole(String executionRole)

      Contains the ARN of the execution role for the workgroup

      Parameters:
      executionRole - Contains the ARN of the execution role for the workgroup
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerContentEncryptionConfiguration

      WorkGroupConfigurationUpdates.Builder customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)
      Sets the value of the CustomerContentEncryptionConfiguration property for this object.
      Parameters:
      customerContentEncryptionConfiguration - The new value for the CustomerContentEncryptionConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerContentEncryptionConfiguration

      default WorkGroupConfigurationUpdates.Builder customerContentEncryptionConfiguration(Consumer<CustomerContentEncryptionConfiguration.Builder> customerContentEncryptionConfiguration)
      Sets the value of the CustomerContentEncryptionConfiguration property for this object. This is a convenience method that creates an instance of the CustomerContentEncryptionConfiguration.Builder avoiding the need to create one manually via CustomerContentEncryptionConfiguration.builder().

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

      Parameters:
      customerContentEncryptionConfiguration - a consumer that will call methods on CustomerContentEncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableMinimumEncryptionConfiguration

      WorkGroupConfigurationUpdates.Builder enableMinimumEncryptionConfiguration(Boolean enableMinimumEncryptionConfiguration)

      Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

      The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

      Parameters:
      enableMinimumEncryptionConfiguration - Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

      The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

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