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

Interface WorkGroupConfiguration.Builder

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

  • Method Details

    • resultConfiguration

      WorkGroupConfiguration.Builder resultConfiguration(ResultConfiguration resultConfiguration)

      The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.

      Parameters:
      resultConfiguration - The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultConfiguration

      default WorkGroupConfiguration.Builder resultConfiguration(Consumer<ResultConfiguration.Builder> resultConfiguration)

      The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.

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

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

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

    • enforceWorkGroupConfiguration

      WorkGroupConfiguration.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.

    • publishCloudWatchMetricsEnabled

      WorkGroupConfiguration.Builder publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)

      Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

      Parameters:
      publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bytesScannedCutoffPerQuery

      WorkGroupConfiguration.Builder bytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)

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

      Parameters:
      bytesScannedCutoffPerQuery - The upper data usage 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.

    • requesterPaysEnabled

      WorkGroupConfiguration.Builder requesterPaysEnabled(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.

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

    • engineVersion

      WorkGroupConfiguration.Builder engineVersion(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.

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

    • engineVersion

      default WorkGroupConfiguration.Builder engineVersion(Consumer<EngineVersion.Builder> 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.

      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:

    • additionalConfiguration

      WorkGroupConfiguration.Builder additionalConfiguration(String additionalConfiguration)

      Specifies a user defined JSON string that is passed to the notebook engine.

      Parameters:
      additionalConfiguration - Specifies a user defined JSON string that is passed to the notebook engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRole

      WorkGroupConfiguration.Builder executionRole(String executionRole)

      The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

      Parameters:
      executionRole - The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerContentEncryptionConfiguration

      WorkGroupConfiguration.Builder customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)

      Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

      Parameters:
      customerContentEncryptionConfiguration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerContentEncryptionConfiguration

      default WorkGroupConfiguration.Builder customerContentEncryptionConfiguration(Consumer<CustomerContentEncryptionConfiguration.Builder> customerContentEncryptionConfiguration)

      Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

      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

      WorkGroupConfiguration.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.

      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.

      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.

    • identityCenterConfiguration

      WorkGroupConfiguration.Builder identityCenterConfiguration(IdentityCenterConfiguration identityCenterConfiguration)

      Specifies whether the workgroup is IAM Identity Center supported.

      Parameters:
      identityCenterConfiguration - Specifies whether the workgroup is IAM Identity Center supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityCenterConfiguration

      default WorkGroupConfiguration.Builder identityCenterConfiguration(Consumer<IdentityCenterConfiguration.Builder> identityCenterConfiguration)

      Specifies whether the workgroup is IAM Identity Center supported.

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

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

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

    • queryResultsS3AccessGrantsConfiguration

      WorkGroupConfiguration.Builder queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration)

      Specifies whether Amazon S3 access grants are enabled for query results.

      Parameters:
      queryResultsS3AccessGrantsConfiguration - Specifies whether Amazon S3 access grants are enabled for query results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryResultsS3AccessGrantsConfiguration

      default WorkGroupConfiguration.Builder queryResultsS3AccessGrantsConfiguration(Consumer<QueryResultsS3AccessGrantsConfiguration.Builder> queryResultsS3AccessGrantsConfiguration)

      Specifies whether Amazon S3 access grants are enabled for query results.

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

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

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