Interface EnableLoggingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>, RedshiftRequest.Builder, SdkBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
EnableLoggingRequest
@Mutable @NotThreadSafe public static interface EnableLoggingRequest.Builder extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>

  • Method Details

    • clusterIdentifier

      EnableLoggingRequest.Builder clusterIdentifier(String clusterIdentifier)

      The identifier of the cluster on which logging is to be started.

      Example: examplecluster

      Parameters:
      clusterIdentifier - The identifier of the cluster on which logging is to be started.

      Example: examplecluster

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

    • bucketName

      EnableLoggingRequest.Builder bucketName(String bucketName)

      The name of an existing S3 bucket where the log files are to be stored.

      Constraints:

      • Must be in the same region as the cluster

      • The cluster must have read bucket and put object permissions

      Parameters:
      bucketName - The name of an existing S3 bucket where the log files are to be stored.

      Constraints:

      • Must be in the same region as the cluster

      • The cluster must have read bucket and put object permissions

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

    • s3KeyPrefix

      EnableLoggingRequest.Builder s3KeyPrefix(String s3KeyPrefix)

      The prefix applied to the log file names.

      Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash ( /), equal (=), plus (+), backslash (\), hyphen ( -), at symbol (@).

      Parameters:
      s3KeyPrefix - The prefix applied to the log file names.

      Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon ( :), slash (/), equal (=), plus (+), backslash ( \), hyphen (-), at symbol (@).

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

    • logDestinationType

      EnableLoggingRequest.Builder logDestinationType(String logDestinationType)

      The log destination type. An enum with possible values of s3, cloudwatch, and s3table.

      Parameters:
      logDestinationType - The log destination type. An enum with possible values of s3, cloudwatch, and s3table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logDestinationType

      EnableLoggingRequest.Builder logDestinationType(LogDestinationType logDestinationType)

      The log destination type. An enum with possible values of s3, cloudwatch, and s3table.

      Parameters:
      logDestinationType - The log destination type. An enum with possible values of s3, cloudwatch, and s3table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logExports

      EnableLoggingRequest.Builder logExports(Collection<String> logExports)

      The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables.

      Parameters:
      logExports - The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logExports

      EnableLoggingRequest.Builder logExports(String... logExports)

      The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables.

      Parameters:
      logExports - The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3TableKmsKeyId

      EnableLoggingRequest.Builder s3TableKmsKeyId(String s3TableKmsKeyId)

      The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when LogDestinationType is s3table.

      Parameters:
      s3TableKmsKeyId - The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when LogDestinationType is s3table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3TableGranularity

      EnableLoggingRequest.Builder s3TableGranularity(String s3TableGranularity)

      The scope of system table publishing. Valid values are cluster and account. A value of cluster scopes publishing to the individual cluster. A value of account scopes publishing to the Amazon Web Services account. This parameter is valid only when LogDestinationType is s3table.

      Parameters:
      s3TableGranularity - The scope of system table publishing. Valid values are cluster and account. A value of cluster scopes publishing to the individual cluster. A value of account scopes publishing to the Amazon Web Services account. This parameter is valid only when LogDestinationType is s3table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      EnableLoggingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      EnableLoggingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.