Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

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.
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.
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 Amazon Web Services KMS customer master key (CMK).

Instances

Instances details

Eq StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods (==) :: StartActivityStream -> StartActivityStream -> Bool # (/=) :: StartActivityStream -> StartActivityStream -> Bool #
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 #
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 #
NFData StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods rnf :: StartActivityStream -> () #
Hashable StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods hashWithSalt :: Int -> StartActivityStream -> Int # hash :: StartActivityStream -> Int #
AWSRequest StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Associated Types type AWSResponse StartActivityStream # Methods request :: StartActivityStream -> Request StartActivityStream # response :: MonadResource m => Logger -> Service -> Proxy StartActivityStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartActivityStream))) #
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 #
type Rep StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type Rep StartActivityStream = D1 ('MetaData "StartActivityStream" "Amazonka.RDS.StartActivityStream" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "StartActivityStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "applyImmediately") '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)))))
type AWSResponse StartActivityStream Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type AWSResponse StartActivityStream = StartActivityStreamResponse

newStartActivityStream Source #

Arguments

:: Text	`$sel:resourceArn:StartActivityStream'`
-> ActivityStreamMode	`$sel:mode:StartActivityStream'`
-> Text	`$sel:kmsKeyId: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:

$sel:engineNativeAuditFieldsIncluded: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:applyImmediately: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.

$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.

$sel:mode: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.

$sel:kmsKeyId: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 Amazon Web Services KMS customer master key (CMK).

Request Lenses

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_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_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 Amazon Web Services KMS customer master key (CMK).

Destructuring the Response

data StartActivityStreamResponse Source #

See: newStartActivityStreamResponse smart constructor.

Constructors

StartActivityStreamResponse'

Fields

status :: Maybe ActivityStreamStatus
The status of the database activity stream.
kinesisStreamName :: Maybe Text
The name of the Amazon Kinesis data stream to be used for the database activity stream.
engineNativeAuditFieldsIncluded :: Maybe Bool
Indicates whether engine-native audit fields are included in the database activity stream.
mode :: Maybe ActivityStreamMode
The mode of the database activity stream.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods (==) :: StartActivityStreamResponse -> StartActivityStreamResponse -> Bool # (/=) :: StartActivityStreamResponse -> StartActivityStreamResponse -> Bool #
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 #
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 #
NFData StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream Methods rnf :: StartActivityStreamResponse -> () #
type Rep StartActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.StartActivityStream type Rep StartActivityStreamResponse = D1 ('MetaData "StartActivityStreamResponse" "Amazonka.RDS.StartActivityStream" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "StartActivityStreamResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)) :: (S1 ('MetaSel ('Just "kinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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:

$sel:status:StartActivityStreamResponse', startActivityStreamResponse_status - The status of 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.

$sel:engineNativeAuditFieldsIncluded:StartActivityStream', startActivityStreamResponse_engineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.

$sel:mode:StartActivityStream', startActivityStreamResponse_mode - The mode of the database activity stream.

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

$sel:applyImmediately: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.

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

Response Lenses

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

The status of 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_engineNativeAuditFieldsIncluded :: Lens' StartActivityStreamResponse (Maybe Bool) Source #

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

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

The mode of 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_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_httpStatus :: Lens' StartActivityStreamResponse Int Source #

The response's http status code.