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.RDS.StartActivityStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Synopsis

Creating a Request

data StartActivityStream Source #

See: newStartActivityStream smart constructor.

Constructors

StartActivityStream'

Fields

applyImmediately :: Maybe Bool
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
engineNativeAuditFieldsIncluded :: Maybe Bool
Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.
resourceArn :: Text
The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
mode :: ActivityStreamMode
Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
kmsKeyId :: Text
The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Instances

Instances details

ToHeaders StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods toHeaders :: StartActivityStream -> [Header] #
ToPath StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods toPath :: StartActivityStream -> ByteString #
ToQuery StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods toQuery :: StartActivityStream -> QueryString #
AWSRequest StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Associated Types type AWSResponse StartActivityStream # Methods request :: (Service -> Service) -> StartActivityStream -> Request StartActivityStream # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartActivityStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartActivityStream))) #
Generic StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Associated Types type Rep StartActivityStream :: Type -> Type # Methods from :: StartActivityStream -> Rep StartActivityStream x # to :: Rep StartActivityStream x -> StartActivityStream #
Read StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods readsPrec :: Int -> ReadS StartActivityStream # readList :: ReadS [StartActivityStream] # readPrec :: ReadPrec StartActivityStream # readListPrec :: ReadPrec [StartActivityStream] #
Show StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods showsPrec :: Int -> StartActivityStream -> ShowS # show :: StartActivityStream -> String # showList :: [StartActivityStream] -> ShowS #
NFData StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods rnf :: StartActivityStream -> () #
Eq StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods (==) :: StartActivityStream -> StartActivityStream -> Bool # (/=) :: StartActivityStream -> StartActivityStream -> Bool #
Hashable StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods hashWithSalt :: Int -> StartActivityStream -> Int # hash :: StartActivityStream -> Int #
type AWSResponse StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type AWSResponse StartActivityStream = StartActivityStreamResponse
type Rep StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type Rep StartActivityStream = D1 ('MetaData "StartActivityStream" "Amazonka.RDS.StartActivityStream" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "StartActivityStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivityStreamMode) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartActivityStream Source #

Arguments

:: Text	`$sel:resourceArn:StartActivityStream'`
-> ActivityStreamMode	`StartActivityStream`
-> Text	`StartActivityStream`
-> StartActivityStream

Create a value of StartActivityStream 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:

StartActivityStream, startActivityStream_applyImmediately - Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

StartActivityStream, startActivityStream_engineNativeAuditFieldsIncluded - Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.

$sel:resourceArn:StartActivityStream', startActivityStream_resourceArn - The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

StartActivityStream, startActivityStream_mode - Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

StartActivityStream, startActivityStream_kmsKeyId - The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Request Lenses

startActivityStream_applyImmediately :: Lens' StartActivityStream (Maybe Bool) Source #

Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

startActivityStream_engineNativeAuditFieldsIncluded :: Lens' StartActivityStream (Maybe Bool) Source #

Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.

startActivityStream_resourceArn :: Lens' StartActivityStream Text Source #

The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

startActivityStream_mode :: Lens' StartActivityStream ActivityStreamMode Source #

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

startActivityStream_kmsKeyId :: Lens' StartActivityStream Text Source #

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Destructuring the Response

data StartActivityStreamResponse Source #

See: newStartActivityStreamResponse smart constructor.

Constructors

StartActivityStreamResponse'

Fields

applyImmediately :: Maybe Bool
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
engineNativeAuditFieldsIncluded :: Maybe Bool
Indicates whether engine-native audit fields are included in the database activity stream.
kinesisStreamName :: Maybe Text
The name of the Amazon Kinesis data stream to be used for the database activity stream.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
mode :: Maybe ActivityStreamMode
The mode of the database activity stream.
status :: Maybe ActivityStreamStatus
The status of the database activity stream.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Associated Types type Rep StartActivityStreamResponse :: Type -> Type # Methods from :: StartActivityStreamResponse -> Rep StartActivityStreamResponse x # to :: Rep StartActivityStreamResponse x -> StartActivityStreamResponse #
Read StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods readsPrec :: Int -> ReadS StartActivityStreamResponse # readList :: ReadS [StartActivityStreamResponse] # readPrec :: ReadPrec StartActivityStreamResponse # readListPrec :: ReadPrec [StartActivityStreamResponse] #
Show StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods showsPrec :: Int -> StartActivityStreamResponse -> ShowS # show :: StartActivityStreamResponse -> String # showList :: [StartActivityStreamResponse] -> ShowS #
NFData StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods rnf :: StartActivityStreamResponse -> () #
Eq StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods (==) :: StartActivityStreamResponse -> StartActivityStreamResponse -> Bool # (/=) :: StartActivityStreamResponse -> StartActivityStreamResponse -> Bool #
type Rep StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type Rep StartActivityStreamResponse = D1 ('MetaData "StartActivityStreamResponse" "Amazonka.RDS.StartActivityStream" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "StartActivityStreamResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "engineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartActivityStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartActivityStreamResponse'`
-> StartActivityStreamResponse

Create a value of StartActivityStreamResponse 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:

StartActivityStream, startActivityStreamResponse_applyImmediately - Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

StartActivityStream, startActivityStreamResponse_engineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.

$sel:kinesisStreamName:StartActivityStreamResponse', startActivityStreamResponse_kinesisStreamName - The name of the Amazon Kinesis data stream to be used for the database activity stream.

StartActivityStream, startActivityStreamResponse_kmsKeyId - The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

StartActivityStream, startActivityStreamResponse_mode - The mode of the database activity stream.

StartActivityStreamResponse, startActivityStreamResponse_status - The status of the database activity stream.

$sel:httpStatus:StartActivityStreamResponse', startActivityStreamResponse_httpStatus - The response's http status code.

Response Lenses

startActivityStreamResponse_applyImmediately :: Lens' StartActivityStreamResponse (Maybe Bool) Source #

Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

startActivityStreamResponse_engineNativeAuditFieldsIncluded :: Lens' StartActivityStreamResponse (Maybe Bool) Source #

Indicates whether engine-native audit fields are included in the database activity stream.

startActivityStreamResponse_kinesisStreamName :: Lens' StartActivityStreamResponse (Maybe Text) Source #

The name of the Amazon Kinesis data stream to be used for the database activity stream.

startActivityStreamResponse_kmsKeyId :: Lens' StartActivityStreamResponse (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

startActivityStreamResponse_mode :: Lens' StartActivityStreamResponse (Maybe ActivityStreamMode) Source #

The mode of the database activity stream.

startActivityStreamResponse_status :: Lens' StartActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

startActivityStreamResponse_httpStatus :: Lens' StartActivityStreamResponse Int Source #

The response's http status code.