You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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", # required
  s3_key_prefix: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

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)


3747
3748
3749
3750
3751
3752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3747

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix)
  include Aws::Structure
end

#cluster_identifierString

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

Example: examplecluster

Returns:

  • (String)


3747
3748
3749
3750
3751
3752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3747

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix)
  include Aws::Structure
end

#s3_key_prefixString

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)


3747
3748
3749
3750
3751
3752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3747

class EnableLoggingMessage < Struct.new(
  :cluster_identifier,
  :bucket_name,
  :s3_key_prefix)
  include Aws::Structure
end