Package software.amazon.awscdk.services.athena

Class CfnWorkGroupProps.Builder

java.lang.Object
software.amazon.awscdk.services.athena.CfnWorkGroupProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkGroupProps>
Enclosing interface:
CfnWorkGroupProps
@Stability(Stable) public static final class CfnWorkGroupProps.Builder extends Object implements software.amazon.jsii.Builder<CfnWorkGroupProps>
A builder for CfnWorkGroupProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnWorkGroupProps.Builder name(String name)
      Sets the value of CfnWorkGroupProps.getName()
      Parameters:
      name - The workgroup name. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnWorkGroupProps.Builder description(String description)
      Sets the value of CfnWorkGroupProps.getDescription()
      Parameters:
      description - The workgroup description.
      Returns:
      this

    • recursiveDeleteOption

      @Stability(Stable) public CfnWorkGroupProps.Builder recursiveDeleteOption(Boolean recursiveDeleteOption)
      Sets the value of CfnWorkGroupProps.getRecursiveDeleteOption()
      Parameters:
      recursiveDeleteOption - The option to delete a workgroup and its contents even if the workgroup contains any named queries. The default is false.
      Returns:
      this

    • recursiveDeleteOption

      @Stability(Stable) public CfnWorkGroupProps.Builder recursiveDeleteOption(IResolvable recursiveDeleteOption)
      Sets the value of CfnWorkGroupProps.getRecursiveDeleteOption()
      Parameters:
      recursiveDeleteOption - The option to delete a workgroup and its contents even if the workgroup contains any named queries. The default is false.
      Returns:
      this

    • state

      @Stability(Stable) public CfnWorkGroupProps.Builder state(String state)
      Sets the value of CfnWorkGroupProps.getState()
      Parameters:
      state - The state of the workgroup: ENABLED or DISABLED.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnWorkGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnWorkGroupProps.getTags()
      Parameters:
      tags - The tags (key-value pairs) to associate with this resource.
      Returns:
      this

    • workGroupConfiguration

      @Stability(Stable) public CfnWorkGroupProps.Builder workGroupConfiguration(IResolvable workGroupConfiguration)
      Sets the value of CfnWorkGroupProps.getWorkGroupConfiguration()
      Parameters:
      workGroupConfiguration - 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 Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.
      Returns:
      this

    • workGroupConfiguration

      @Stability(Stable) public CfnWorkGroupProps.Builder workGroupConfiguration(CfnWorkGroup.WorkGroupConfigurationProperty workGroupConfiguration)
      Sets the value of CfnWorkGroupProps.getWorkGroupConfiguration()
      Parameters:
      workGroupConfiguration - 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 Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.
      Returns:
      this

    • workGroupConfigurationUpdates

      @Stability(Deprecated) @Deprecated public CfnWorkGroupProps.Builder workGroupConfigurationUpdates(IResolvable workGroupConfigurationUpdates)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnWorkGroupProps.getWorkGroupConfigurationUpdates()
      Parameters:
      workGroupConfigurationUpdates - The configuration information that will be updated for this 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, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
      Returns:
      this

    • workGroupConfigurationUpdates

      @Stability(Deprecated) @Deprecated public CfnWorkGroupProps.Builder workGroupConfigurationUpdates(CfnWorkGroup.WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdates)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnWorkGroupProps.getWorkGroupConfigurationUpdates()
      Parameters:
      workGroupConfigurationUpdates - The configuration information that will be updated for this 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, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
      Returns:
      this

    • build

      @Stability(Stable) public CfnWorkGroupProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWorkGroupProps>
      Returns:
      a new instance of CfnWorkGroupProps
      Throws:
      NullPointerException - if any required attribute was not provided