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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.

This operation is supported for RDS for Oracle only.

Synopsis

Creating a Request

data ModifyActivityStream Source #

See: newModifyActivityStream smart constructor.

Constructors

ModifyActivityStream'

Fields

auditPolicyState :: Maybe AuditPolicyState
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

Instances

Instances details

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

newModifyActivityStream :: ModifyActivityStream Source #

Create a value of ModifyActivityStream 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:auditPolicyState:ModifyActivityStream', modifyActivityStream_auditPolicyState - The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

$sel:resourceArn:ModifyActivityStream', modifyActivityStream_resourceArn - The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

Request Lenses

modifyActivityStream_auditPolicyState :: Lens' ModifyActivityStream (Maybe AuditPolicyState) Source #

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

modifyActivityStream_resourceArn :: Lens' ModifyActivityStream (Maybe Text) Source #

The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

Destructuring the Response

data ModifyActivityStreamResponse Source #

See: newModifyActivityStreamResponse smart constructor.

Constructors

ModifyActivityStreamResponse'

Fields

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.
policyStatus :: Maybe ActivityStreamPolicyStatus
The status of the modification to the policy state of the database activity stream.
status :: Maybe ActivityStreamStatus
The status of the modification to the database activity stream.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream Associated Types type Rep ModifyActivityStreamResponse :: Type -> Type # Methods from :: ModifyActivityStreamResponse -> Rep ModifyActivityStreamResponse x # to :: Rep ModifyActivityStreamResponse x -> ModifyActivityStreamResponse #
Read ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream Methods readsPrec :: Int -> ReadS ModifyActivityStreamResponse # readList :: ReadS [ModifyActivityStreamResponse] # readPrec :: ReadPrec ModifyActivityStreamResponse # readListPrec :: ReadPrec [ModifyActivityStreamResponse] #
Show ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream Methods showsPrec :: Int -> ModifyActivityStreamResponse -> ShowS # show :: ModifyActivityStreamResponse -> String # showList :: [ModifyActivityStreamResponse] -> ShowS #
NFData ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream Methods rnf :: ModifyActivityStreamResponse -> () #
Eq ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream Methods (==) :: ModifyActivityStreamResponse -> ModifyActivityStreamResponse -> Bool # (/=) :: ModifyActivityStreamResponse -> ModifyActivityStreamResponse -> Bool #
type Rep ModifyActivityStreamResponse Source #
Instance details Defined in Amazonka.RDS.ModifyActivityStream type Rep ModifyActivityStreamResponse = D1 ('MetaData "ModifyActivityStreamResponse" "Amazonka.RDS.ModifyActivityStream" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyActivityStreamResponse'" 'PrefixI 'True) ((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 "policyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamPolicyStatus))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newModifyActivityStreamResponse Source #

Arguments

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

Create a value of ModifyActivityStreamResponse 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:ModifyActivityStreamResponse', modifyActivityStreamResponse_engineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.

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

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

$sel:mode:ModifyActivityStreamResponse', modifyActivityStreamResponse_mode - The mode of the database activity stream.

$sel:policyStatus:ModifyActivityStreamResponse', modifyActivityStreamResponse_policyStatus - The status of the modification to the policy state of the database activity stream.

ModifyActivityStreamResponse, modifyActivityStreamResponse_status - The status of the modification to the database activity stream.

$sel:httpStatus:ModifyActivityStreamResponse', modifyActivityStreamResponse_httpStatus - The response's http status code.

Response Lenses

modifyActivityStreamResponse_engineNativeAuditFieldsIncluded :: Lens' ModifyActivityStreamResponse (Maybe Bool) Source #

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

modifyActivityStreamResponse_kinesisStreamName :: Lens' ModifyActivityStreamResponse (Maybe Text) Source #

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

modifyActivityStreamResponse_kmsKeyId :: Lens' ModifyActivityStreamResponse (Maybe Text) Source #

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

modifyActivityStreamResponse_mode :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamMode) Source #

The mode of the database activity stream.

modifyActivityStreamResponse_policyStatus :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamPolicyStatus) Source #

The status of the modification to the policy state of the database activity stream.

modifyActivityStreamResponse_status :: Lens' ModifyActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the modification to the database activity stream.

modifyActivityStreamResponse_httpStatus :: Lens' ModifyActivityStreamResponse Int Source #

The response's http status code.