Skip to content

EnableLoggingMessage

Source code in docs_src/capo_redshift/types/enable_logging_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class EnableLoggingMessage(TypedDict, closed=True):
    cluster_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the cluster on which logging is to be started.</p> <p>Example: <code>examplecluster</code> </p>"""
    bucket_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of an existing S3 bucket where the log files are to be stored.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the same region as the cluster</p> </li> <li> <p>The cluster must have read bucket and put object permissions</p> </li> </ul>"""
    s3_key_prefix: NotRequired[
        "capo_redshift.types.s3_key_prefix_value.S3KeyPrefixValue"
    ]
    r"""<p>The prefix applied to the log file names.</p> <p>Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (<code>_</code>), period (<code>.</code>), colon (<code>:</code>), slash (<code>/</code>), equal (<code>=</code>), plus (<code>+</code>), backslash (<code>\</code>), hyphen (<code>-</code>), at symbol (<code>@</code>).</p>"""
    log_destination_type: NotRequired[
        "capo_redshift.types.log_destination_type.LogDestinationType"
    ]
    """<p>The log destination type. An enum with possible values of <code>s3</code>, <code>cloudwatch</code>, and <code>s3table</code>.</p>"""
    log_exports: NotRequired["capo_redshift.types.log_type_list.LogTypeList"]
    """<p>The collection of exported log types. When <code>LogDestinationType</code> is <code>s3</code> or <code>cloudwatch</code>, possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>. When <code>LogDestinationType</code> is <code>s3table</code>, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value <code>all</code> publishes all current and future system tables.</p>"""
    s3_table_kms_key_id: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when <code>LogDestinationType</code> is <code>s3table</code>.</p>"""
    s3_table_granularity: NotRequired["capo_redshift.types.string.String"]
    """<p>The scope of system table publishing. Valid values are <code>cluster</code> and <code>account</code>. A value of <code>cluster</code> scopes publishing to the individual cluster. A value of <code>account</code> scopes publishing to the Amazon Web Services account. This parameter is valid only when <code>LogDestinationType</code> is <code>s3table</code>.</p>"""

bucket_name instance-attribute 

bucket_name: NotRequired[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

cluster_identifier instance-attribute 

cluster_identifier: NotRequired[String]

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

Example: examplecluster

log_destination_type instance-attribute 

log_destination_type: NotRequired[LogDestinationType]

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

log_exports instance-attribute 

log_exports: NotRequired[LogTypeList]

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.

s3_key_prefix instance-attribute 

s3_key_prefix: NotRequired[S3KeyPrefixValue]

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 (@).

s3_table_granularity instance-attribute 

s3_table_granularity: NotRequired[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.

s3_table_kms_key_id instance-attribute 

s3_table_kms_key_id: NotRequired[String]

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