Network.AWS.Redshift.EnableLogging

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

Creating a Request

enableLogging

Arguments

:: Text

elClusterIdentifier

-> Text

elBucketName

-> EnableLogging

Creates a value of EnableLogging with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• elS3KeyPrefix - 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
• elClusterIdentifier - The identifier of the cluster on which logging is to be started. Example: examplecluster
• elBucketName - 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

data EnableLogging

See: enableLogging smart constructor.

Instances

Eq EnableLogging

Methods

(==) :: EnableLogging -> EnableLogging -> Bool

(/=) :: EnableLogging -> EnableLogging -> Bool

Data EnableLogging

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnableLogging -> c EnableLogging

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnableLogging

toConstr :: EnableLogging -> Constr

dataTypeOf :: EnableLogging -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnableLogging)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnableLogging)

gmapT :: (forall b. Data b => b -> b) -> EnableLogging -> EnableLogging

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnableLogging -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnableLogging -> r

gmapQ :: (forall d. Data d => d -> u) -> EnableLogging -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnableLogging -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnableLogging -> m EnableLogging

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableLogging -> m EnableLogging

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnableLogging -> m EnableLogging

Read EnableLogging

Methods

readsPrec :: Int -> ReadS EnableLogging

readList :: ReadS [EnableLogging]

readPrec :: ReadPrec EnableLogging

readListPrec :: ReadPrec [EnableLogging]

Show EnableLogging

Methods

showsPrec :: Int -> EnableLogging -> ShowS

show :: EnableLogging -> String

showList :: [EnableLogging] -> ShowS

Generic EnableLogging

Associated Types

type Rep EnableLogging :: * -> *

Methods

from :: EnableLogging -> Rep EnableLogging x

to :: Rep EnableLogging x -> EnableLogging

Hashable EnableLogging

Methods

hashWithSalt :: Int -> EnableLogging -> Int

hash :: EnableLogging -> Int

NFData EnableLogging

Methods

rnf :: EnableLogging -> ()

AWSRequest EnableLogging

Associated Types

type Rs EnableLogging :: *

Methods

request :: EnableLogging -> Request EnableLogging

response :: MonadResource m => Logger -> Service -> Proxy * EnableLogging -> ClientResponse -> m (Response EnableLogging)

ToPath EnableLogging

Methods

toPath :: EnableLogging -> ByteString

ToHeaders EnableLogging

Methods

toHeaders :: EnableLogging -> [Header]

ToQuery EnableLogging

Methods

toQuery :: EnableLogging -> QueryString

type Rep EnableLogging

type Rep EnableLogging = D1 (MetaData "EnableLogging" "Network.AWS.Redshift.EnableLogging" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "EnableLogging'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_elS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_elClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_elBucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs EnableLogging

type Rs EnableLogging = LoggingStatus

Request Lenses

elS3KeyPrefix :: Lens' EnableLogging (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

elClusterIdentifier :: Lens' EnableLogging Text

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

elBucketName :: Lens' EnableLogging 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

Destructuring the Response

loggingStatus :: LoggingStatus

Creates a value of LoggingStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lsLastFailureTime - The last time when logs failed to be delivered.
• lsLastSuccessfulDeliveryTime - The last time that logs were delivered.
• lsS3KeyPrefix - The prefix applied to the log file names.
• lsBucketName - The name of the S3 bucket where the log files are stored.
• lsLoggingEnabled - true if logging is on, false if logging is off.
• lsLastFailureMessage - The message indicating that logs failed to be delivered.

data LoggingStatus

Describes the status of logging for a cluster.

See: loggingStatus smart constructor.

Instances

Eq LoggingStatus

Methods

(==) :: LoggingStatus -> LoggingStatus -> Bool

(/=) :: LoggingStatus -> LoggingStatus -> Bool

Data LoggingStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LoggingStatus -> c LoggingStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LoggingStatus

toConstr :: LoggingStatus -> Constr

dataTypeOf :: LoggingStatus -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LoggingStatus)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LoggingStatus)

gmapT :: (forall b. Data b => b -> b) -> LoggingStatus -> LoggingStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LoggingStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LoggingStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> LoggingStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LoggingStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LoggingStatus -> m LoggingStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LoggingStatus -> m LoggingStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LoggingStatus -> m LoggingStatus

Read LoggingStatus

Methods

readsPrec :: Int -> ReadS LoggingStatus

readList :: ReadS [LoggingStatus]

readPrec :: ReadPrec LoggingStatus

readListPrec :: ReadPrec [LoggingStatus]

Show LoggingStatus

Methods

showsPrec :: Int -> LoggingStatus -> ShowS

show :: LoggingStatus -> String

showList :: [LoggingStatus] -> ShowS

Generic LoggingStatus

Associated Types

type Rep LoggingStatus :: * -> *

Methods

from :: LoggingStatus -> Rep LoggingStatus x

to :: Rep LoggingStatus x -> LoggingStatus

Hashable LoggingStatus

Methods

hashWithSalt :: Int -> LoggingStatus -> Int

hash :: LoggingStatus -> Int

NFData LoggingStatus

Methods

rnf :: LoggingStatus -> ()

FromXML LoggingStatus

Methods

parseXML :: [Node] -> Either String LoggingStatus

type Rep LoggingStatus

type Rep LoggingStatus = D1 (MetaData "LoggingStatus" "Network.AWS.Redshift.Types.Product" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "LoggingStatus'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lsLastFailureTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) ((:*:) (S1 (MetaSel (Just Symbol "_lsLastSuccessfulDeliveryTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_lsS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_lsBucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lsLoggingEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lsLastFailureMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

Response Lenses

lsLastFailureTime :: Lens' LoggingStatus (Maybe UTCTime)

The last time when logs failed to be delivered.

lsLastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime)

The last time that logs were delivered.

lsS3KeyPrefix :: Lens' LoggingStatus (Maybe Text)

The prefix applied to the log file names.

lsBucketName :: Lens' LoggingStatus (Maybe Text)

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

lsLoggingEnabled :: Lens' LoggingStatus (Maybe Bool)

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

lsLastFailureMessage :: Lens' LoggingStatus (Maybe Text)

The message indicating that logs failed to be delivered.