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

Interface ResultConfigurationUpdates.Builder

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

  • Method Details

    • outputLocation

      ResultConfigurationUpdates.Builder outputLocation(String outputLocation)

      The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

      Parameters:
      outputLocation - The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeOutputLocation

      ResultConfigurationUpdates.Builder removeOutputLocation(Boolean removeOutputLocation)

      If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

      Parameters:
      removeOutputLocation - If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. 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.

    • encryptionConfiguration

      ResultConfigurationUpdates.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      The encryption configuration for query and calculation results.

      Parameters:
      encryptionConfiguration - The encryption configuration for query and calculation results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default ResultConfigurationUpdates.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

      The encryption configuration for query and calculation results.

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

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

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

    • removeEncryptionConfiguration

      ResultConfigurationUpdates.Builder removeEncryptionConfiguration(Boolean removeEncryptionConfiguration)

      If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

      Parameters:
      removeEncryptionConfiguration - If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. 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.

    • expectedBucketOwner

      ResultConfigurationUpdates.Builder expectedBucketOwner(String expectedBucketOwner)

      The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

      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. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

      Parameters:
      expectedBucketOwner - The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

      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. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

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

    • removeExpectedBucketOwner

      ResultConfigurationUpdates.Builder removeExpectedBucketOwner(Boolean removeExpectedBucketOwner)

      If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

      Parameters:
      removeExpectedBucketOwner - If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. 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.

    • aclConfiguration

      ResultConfigurationUpdates.Builder aclConfiguration(AclConfiguration aclConfiguration)

      The ACL configuration for the query results.

      Parameters:
      aclConfiguration - The ACL configuration for the query results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aclConfiguration

      default ResultConfigurationUpdates.Builder aclConfiguration(Consumer<AclConfiguration.Builder> aclConfiguration)

      The ACL configuration for the query results.

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

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

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

    • removeAclConfiguration

      ResultConfigurationUpdates.Builder removeAclConfiguration(Boolean removeAclConfiguration)

      If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

      Parameters:
      removeAclConfiguration - If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. 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.