Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.EnableLogging

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data EnableLogging = EnableLogging' {
- bucketName :: Maybe Text
- logDestinationType :: Maybe LogDestinationType
- logExports :: Maybe [Text]
- s3KeyPrefix :: Maybe Text
- clusterIdentifier :: Text
}
newEnableLogging :: Text -> EnableLogging
enableLogging_bucketName :: Lens' EnableLogging (Maybe Text)
enableLogging_logDestinationType :: Lens' EnableLogging (Maybe LogDestinationType)
enableLogging_logExports :: Lens' EnableLogging (Maybe [Text])
enableLogging_s3KeyPrefix :: Lens' EnableLogging (Maybe Text)
enableLogging_clusterIdentifier :: Lens' EnableLogging Text
data LoggingStatus = LoggingStatus' {
- bucketName :: Maybe Text
- lastFailureMessage :: Maybe Text
- lastFailureTime :: Maybe ISO8601
- lastSuccessfulDeliveryTime :: Maybe ISO8601
- logDestinationType :: Maybe LogDestinationType
- logExports :: Maybe [Text]
- loggingEnabled :: Maybe Bool
- s3KeyPrefix :: Maybe Text
}
newLoggingStatus :: LoggingStatus
loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text)
loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text)
loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime)
loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime)
loggingStatus_logDestinationType :: Lens' LoggingStatus (Maybe LogDestinationType)
loggingStatus_logExports :: Lens' LoggingStatus (Maybe [Text])
loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool)
loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text)

Creating a Request

data EnableLogging Source #

See: newEnableLogging smart constructor.

Constructors

EnableLogging'

Fields

bucketName :: Maybe Text
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
logDestinationType :: Maybe LogDestinationType
The log destination type. An enum with possible values of s3 and cloudwatch.
logExports :: Maybe [Text]
The collection of exported log types. Log types include the connection log, user log and user activity log.
s3KeyPrefix :: Maybe Text
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
clusterIdentifier :: Text
The identifier of the cluster on which logging is to be started.
Example: examplecluster

Instances

Instances details

ToHeaders EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods toHeaders :: EnableLogging -> [Header] #
ToPath EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods toPath :: EnableLogging -> ByteString #
ToQuery EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods toQuery :: EnableLogging -> QueryString #
AWSRequest EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Associated Types type AWSResponse EnableLogging # Methods request :: (Service -> Service) -> EnableLogging -> Request EnableLogging # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableLogging -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableLogging))) #
Generic EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Associated Types type Rep EnableLogging :: Type -> Type # Methods from :: EnableLogging -> Rep EnableLogging x # to :: Rep EnableLogging x -> EnableLogging #
Read EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods readsPrec :: Int -> ReadS EnableLogging # readList :: ReadS [EnableLogging] # readPrec :: ReadPrec EnableLogging # readListPrec :: ReadPrec [EnableLogging] #
Show EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods showsPrec :: Int -> EnableLogging -> ShowS # show :: EnableLogging -> String # showList :: [EnableLogging] -> ShowS #
NFData EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods rnf :: EnableLogging -> () #
Eq EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods (==) :: EnableLogging -> EnableLogging -> Bool # (/=) :: EnableLogging -> EnableLogging -> Bool #
Hashable EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging Methods hashWithSalt :: Int -> EnableLogging -> Int # hash :: EnableLogging -> Int #
type AWSResponse EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging type AWSResponse EnableLogging = LoggingStatus
type Rep EnableLogging Source #
Instance details Defined in Amazonka.Redshift.EnableLogging type Rep EnableLogging = D1 ('MetaData "EnableLogging" "Amazonka.Redshift.EnableLogging" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "EnableLogging'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logDestinationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDestinationType))) :: (S1 ('MetaSel ('Just "logExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "s3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEnableLogging Source #

Arguments

:: Text	`EnableLogging`
-> EnableLogging

Create a value of EnableLogging with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

EnableLogging, enableLogging_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

EnableLogging, enableLogging_logDestinationType - The log destination type. An enum with possible values of s3 and cloudwatch.

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

EnableLogging, enableLogging_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

EnableLogging, enableLogging_clusterIdentifier - The identifier of the cluster on which logging is to be started.

Example: examplecluster

Request Lenses

enableLogging_bucketName :: Lens' EnableLogging (Maybe Text) Source #

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

enableLogging_logDestinationType :: Lens' EnableLogging (Maybe LogDestinationType) Source #

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

enableLogging_logExports :: Lens' EnableLogging (Maybe [Text]) Source #

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

enableLogging_s3KeyPrefix :: Lens' EnableLogging (Maybe Text) Source #

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

enableLogging_clusterIdentifier :: Lens' EnableLogging Text Source #

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

Example: examplecluster

Destructuring the Response

data LoggingStatus Source #

Describes the status of logging for a cluster.

See: newLoggingStatus smart constructor.

Constructors

LoggingStatus'

Fields

bucketName :: Maybe Text
The name of the S3 bucket where the log files are stored.
lastFailureMessage :: Maybe Text
The message indicating that logs failed to be delivered.
lastFailureTime :: Maybe ISO8601
The last time when logs failed to be delivered.
lastSuccessfulDeliveryTime :: Maybe ISO8601
The last time that logs were delivered.
logDestinationType :: Maybe LogDestinationType
The log destination type. An enum with possible values of s3 and cloudwatch.
logExports :: Maybe [Text]
The collection of exported log types. Log types include the connection log, user log and user activity log.
loggingEnabled :: Maybe Bool
true if logging is on, false if logging is off.
s3KeyPrefix :: Maybe Text
The prefix applied to the log file names.

Instances

Instances details

FromXML LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods parseXML :: [Node] -> Either String LoggingStatus #
Generic LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Associated Types type Rep LoggingStatus :: Type -> Type # Methods from :: LoggingStatus -> Rep LoggingStatus x # to :: Rep LoggingStatus x -> LoggingStatus #
Read LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods readsPrec :: Int -> ReadS LoggingStatus # readList :: ReadS [LoggingStatus] # readPrec :: ReadPrec LoggingStatus # readListPrec :: ReadPrec [LoggingStatus] #
Show LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods showsPrec :: Int -> LoggingStatus -> ShowS # show :: LoggingStatus -> String # showList :: [LoggingStatus] -> ShowS #
NFData LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods rnf :: LoggingStatus -> () #
Eq LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods (==) :: LoggingStatus -> LoggingStatus -> Bool # (/=) :: LoggingStatus -> LoggingStatus -> Bool #
Hashable LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus Methods hashWithSalt :: Int -> LoggingStatus -> Int # hash :: LoggingStatus -> Int #
type Rep LoggingStatus Source #
Instance details Defined in Amazonka.Redshift.Types.LoggingStatus type Rep LoggingStatus = D1 ('MetaData "LoggingStatus" "Amazonka.Redshift.Types.LoggingStatus" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "LoggingStatus'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastFailureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastFailureTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "lastSuccessfulDeliveryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "logDestinationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDestinationType)) :: S1 ('MetaSel ('Just "logExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "loggingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "s3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLoggingStatus :: LoggingStatus Source #

Create a value of LoggingStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bucketName:LoggingStatus', loggingStatus_bucketName - The name of the S3 bucket where the log files are stored.

$sel:lastFailureMessage:LoggingStatus', loggingStatus_lastFailureMessage - The message indicating that logs failed to be delivered.

$sel:lastFailureTime:LoggingStatus', loggingStatus_lastFailureTime - The last time when logs failed to be delivered.

$sel:lastSuccessfulDeliveryTime:LoggingStatus', loggingStatus_lastSuccessfulDeliveryTime - The last time that logs were delivered.

$sel:logDestinationType:LoggingStatus', loggingStatus_logDestinationType - The log destination type. An enum with possible values of s3 and cloudwatch.

$sel:logExports:LoggingStatus', loggingStatus_logExports - The collection of exported log types. Log types include the connection log, user log and user activity log.

$sel:loggingEnabled:LoggingStatus', loggingStatus_loggingEnabled - true if logging is on, false if logging is off.

$sel:s3KeyPrefix:LoggingStatus', loggingStatus_s3KeyPrefix - The prefix applied to the log file names.

Response Lenses

loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text) Source #

The name of the S3 bucket where the log files are stored.

loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text) Source #

The message indicating that logs failed to be delivered.

loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time when logs failed to be delivered.

loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time that logs were delivered.

loggingStatus_logDestinationType :: Lens' LoggingStatus (Maybe LogDestinationType) Source #

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

loggingStatus_logExports :: Lens' LoggingStatus (Maybe [Text]) Source #

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

loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool) Source #

true if logging is on, false if logging is off.

loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text) Source #

The prefix applied to the log file names.