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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass EnableLoggingMessage data as a hash:

{
  cluster_identifier: "String", # required
  bucket_name: "String",
  s3_key_prefix: "String",
  log_destination_type: "s3", # accepts s3, cloudwatch
  log_exports: ["String"],
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


6423
6424
6425
6426
6427
6428
6429
6430
6431
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6423

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

#cluster_identifier ⇒ String

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

Example: examplecluster

Returns:

  • (String) 


6423
6424
6425
6426
6427
6428
6429
6430
6431
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6423

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

#log_destination_type ⇒ String

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

Returns:

  • (String) 


6423
6424
6425
6426
6427
6428
6429
6430
6431
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6423

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

#log_exports ⇒ Array<String>

The collection of exported log types. Log types include the connection log, user log and user activity log.

Returns:

  • (Array<String>) 


6423
6424
6425
6426
6427
6428
6429
6430
6431
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6423

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

#s3_key_prefix ⇒ String

The prefix applied to the log file names.

Constraints:

  • Cannot exceed 512 characters

  • Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

    • x00 to x20

    • x22

    • x27

    • x5c

    • x7f or larger

Returns:

  • (String) 


6423
6424
6425
6426
6427
6428
6429
6430
6431
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6423

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