Skip to content

Enable Logging

redshift_enable_logging R Documentation

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster

Description

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Usage

redshift_enable_logging(ClusterIdentifier, BucketName, S3KeyPrefix,
  LogDestinationType, LogExports)

Arguments

ClusterIdentifier

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

Example: examplecluster

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

S3KeyPrefix

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

LogDestinationType

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

LogExports

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

Value

A list with the following syntax: 

list(
  LoggingEnabled = TRUE|FALSE,
  BucketName = "string",
  S3KeyPrefix = "string",
  LastSuccessfulDeliveryTime = as.POSIXct(
    "2015-01-01"
  ),
  LastFailureTime = as.POSIXct(
    "2015-01-01"
  ),
  LastFailureMessage = "string",
  LogDestinationType = "s3"|"cloudwatch",
  LogExports = list(
    "string"
  )
)

Request syntax

svc$enable_logging(
  ClusterIdentifier = "string",
  BucketName = "string",
  S3KeyPrefix = "string",
  LogDestinationType = "s3"|"cloudwatch",
  LogExports = list(
    "string"
  )
)