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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Synopsis

data StopActivityStream = StopActivityStream' {
- applyImmediately :: Maybe Bool
- resourceArn :: Text
}
newStopActivityStream :: Text -> StopActivityStream
stopActivityStream_applyImmediately :: Lens' StopActivityStream (Maybe Bool)
stopActivityStream_resourceArn :: Lens' StopActivityStream Text
data StopActivityStreamResponse = StopActivityStreamResponse' {
- kinesisStreamName :: Maybe Text
- kmsKeyId :: Maybe Text
- status :: Maybe ActivityStreamStatus
- httpStatus :: Int
}
newStopActivityStreamResponse :: Int -> StopActivityStreamResponse
stopActivityStreamResponse_kinesisStreamName :: Lens' StopActivityStreamResponse (Maybe Text)
stopActivityStreamResponse_kmsKeyId :: Lens' StopActivityStreamResponse (Maybe Text)
stopActivityStreamResponse_status :: Lens' StopActivityStreamResponse (Maybe ActivityStreamStatus)
stopActivityStreamResponse_httpStatus :: Lens' StopActivityStreamResponse Int

Creating a Request

data StopActivityStream Source #

See: newStopActivityStream smart constructor.

Constructors

StopActivityStream'
Fields applyImmediately :: Maybe Bool Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database. resourceArn :: Text The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, `arn:aws:rds:us-east-1:12345667890:cluster:das-cluster`.

Instances

Instances details

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

newStopActivityStream Source #

Arguments

:: Text	`$sel:resourceArn:StopActivityStream'`
-> StopActivityStream

Create a value of StopActivityStream 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:applyImmediately:StopActivityStream', stopActivityStream_applyImmediately - Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

$sel:resourceArn:StopActivityStream', stopActivityStream_resourceArn - The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

Request Lenses

stopActivityStream_applyImmediately :: Lens' StopActivityStream (Maybe Bool) Source #

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

stopActivityStream_resourceArn :: Lens' StopActivityStream Text Source #

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

Destructuring the Response

data StopActivityStreamResponse Source #

See: newStopActivityStreamResponse smart constructor.

Constructors

StopActivityStreamResponse'

Fields

kinesisStreamName :: Maybe Text
The name of the Amazon Kinesis data stream used for the database activity stream.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier used 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.
status :: Maybe ActivityStreamStatus
The status of the database activity stream.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newStopActivityStreamResponse Source #

Arguments

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

Create a value of StopActivityStreamResponse 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:kinesisStreamName:StopActivityStreamResponse', stopActivityStreamResponse_kinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.

StopActivityStreamResponse, stopActivityStreamResponse_kmsKeyId - The Amazon Web Services KMS key identifier used 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.

StopActivityStreamResponse, stopActivityStreamResponse_status - The status of the database activity stream.

$sel:httpStatus:StopActivityStreamResponse', stopActivityStreamResponse_httpStatus - The response's http status code.

Response Lenses

stopActivityStreamResponse_kinesisStreamName :: Lens' StopActivityStreamResponse (Maybe Text) Source #

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

stopActivityStreamResponse_kmsKeyId :: Lens' StopActivityStreamResponse (Maybe Text) Source #

The Amazon Web Services KMS key identifier used 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.

stopActivityStreamResponse_status :: Lens' StopActivityStreamResponse (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

stopActivityStreamResponse_httpStatus :: Lens' StopActivityStreamResponse Int Source #

The response's http status code.