Class: Aws::Redshift::Types::EnableLoggingMessage

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::EnableLoggingMessage

Includes:

Structure

Defined in:

lib/aws-sdk-redshift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_name ⇒ String

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

• #cluster_identifier ⇒ String

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

• #log_destination_type ⇒ String

  The log destination type.

• #log_exports ⇒ Array<String>

  The collection of exported log types.

• #s3_key_prefix ⇒ String

  The prefix applied to the log file names.

• #s3_table_granularity ⇒ String

  The scope of system table publishing.

• #s3_table_kms_key_id ⇒ String

  The identifier of a customer managed KMS key used to encrypt the S3 tables.

Instance Attribute Details

#bucket_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ String

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

Example: examplecluster

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#log_destination_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#log_exports ⇒ Array<String>

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:

• (Array<String>)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#s3_key_prefix ⇒ String

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:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#s3_table_granularity ⇒ String

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:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#s3_table_kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6446

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix,
  :log_destination_type,
  :log_exports,
  :s3_table_kms_key_id,
  :s3_table_granularity)
  SENSITIVE = []
  include Aws::Structure
end