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.TimeStreamWrite.UpdateDatabase

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins.

See code sample for details.

Creating a Request

data UpdateDatabase Source #

See: newUpdateDatabase smart constructor.

Constructors

UpdateDatabase'

Fields

databaseName :: Text
The name of the database.
kmsKeyId :: Text
The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data stored in the database. If the KmsKeyId currently registered with the database is the same as the KmsKeyId in the request, there will not be any update.
You can specify the KmsKeyId using any of the following:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name: alias/ExampleAlias
- Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias

Instances

Instances details

ToJSON UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods toJSON :: UpdateDatabase -> Value # toEncoding :: UpdateDatabase -> Encoding # toJSONList :: [UpdateDatabase] -> Value # toEncodingList :: [UpdateDatabase] -> Encoding #
ToHeaders UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods toHeaders :: UpdateDatabase -> [Header] #
ToPath UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods toPath :: UpdateDatabase -> ByteString #
ToQuery UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods toQuery :: UpdateDatabase -> QueryString #
AWSRequest UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Associated Types type AWSResponse UpdateDatabase # Methods request :: (Service -> Service) -> UpdateDatabase -> Request UpdateDatabase # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDatabase -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDatabase))) #
Generic UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Associated Types type Rep UpdateDatabase :: Type -> Type # Methods from :: UpdateDatabase -> Rep UpdateDatabase x # to :: Rep UpdateDatabase x -> UpdateDatabase #
Read UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods readsPrec :: Int -> ReadS UpdateDatabase # readList :: ReadS [UpdateDatabase] # readPrec :: ReadPrec UpdateDatabase # readListPrec :: ReadPrec [UpdateDatabase] #
Show UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods showsPrec :: Int -> UpdateDatabase -> ShowS # show :: UpdateDatabase -> String # showList :: [UpdateDatabase] -> ShowS #
NFData UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods rnf :: UpdateDatabase -> () #
Eq UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods (==) :: UpdateDatabase -> UpdateDatabase -> Bool # (/=) :: UpdateDatabase -> UpdateDatabase -> Bool #
Hashable UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods hashWithSalt :: Int -> UpdateDatabase -> Int # hash :: UpdateDatabase -> Int #
type AWSResponse UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase type AWSResponse UpdateDatabase = UpdateDatabaseResponse
type Rep UpdateDatabase Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase type Rep UpdateDatabase = D1 ('MetaData "UpdateDatabase" "Amazonka.TimeStreamWrite.UpdateDatabase" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "UpdateDatabase'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateDatabase Source #

Arguments

:: Text	`UpdateDatabase`
-> Text	`UpdateDatabase`
-> UpdateDatabase

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

UpdateDatabase, updateDatabase_databaseName - The name of the database.

UpdateDatabase, updateDatabase_kmsKeyId - The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data stored in the database. If the KmsKeyId currently registered with the database is the same as the KmsKeyId in the request, there will not be any update.

You can specify the KmsKeyId using any of the following:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias

Request Lenses

updateDatabase_databaseName :: Lens' UpdateDatabase Text Source #

The name of the database.

updateDatabase_kmsKeyId :: Lens' UpdateDatabase Text Source #

The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data stored in the database. If the KmsKeyId currently registered with the database is the same as the KmsKeyId in the request, there will not be any update.

You can specify the KmsKeyId using any of the following:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias

Destructuring the Response

data UpdateDatabaseResponse Source #

See: newUpdateDatabaseResponse smart constructor.

Constructors

UpdateDatabaseResponse'
Fields database :: Maybe Database httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Associated Types type Rep UpdateDatabaseResponse :: Type -> Type # Methods from :: UpdateDatabaseResponse -> Rep UpdateDatabaseResponse x # to :: Rep UpdateDatabaseResponse x -> UpdateDatabaseResponse #
Read UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods readsPrec :: Int -> ReadS UpdateDatabaseResponse # readList :: ReadS [UpdateDatabaseResponse] # readPrec :: ReadPrec UpdateDatabaseResponse # readListPrec :: ReadPrec [UpdateDatabaseResponse] #
Show UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods showsPrec :: Int -> UpdateDatabaseResponse -> ShowS # show :: UpdateDatabaseResponse -> String # showList :: [UpdateDatabaseResponse] -> ShowS #
NFData UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods rnf :: UpdateDatabaseResponse -> () #
Eq UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase Methods (==) :: UpdateDatabaseResponse -> UpdateDatabaseResponse -> Bool # (/=) :: UpdateDatabaseResponse -> UpdateDatabaseResponse -> Bool #
type Rep UpdateDatabaseResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.UpdateDatabase type Rep UpdateDatabaseResponse = D1 ('MetaData "UpdateDatabaseResponse" "Amazonka.TimeStreamWrite.UpdateDatabase" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "UpdateDatabaseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Database)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDatabaseResponse Source #

Arguments

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

Create a value of UpdateDatabaseResponse 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:database:UpdateDatabaseResponse', updateDatabaseResponse_database - Undocumented member.

$sel:httpStatus:UpdateDatabaseResponse', updateDatabaseResponse_httpStatus - The response's http status code.

Response Lenses

updateDatabaseResponse_database :: Lens' UpdateDatabaseResponse (Maybe Database) Source #

Undocumented member.

updateDatabaseResponse_httpStatus :: Lens' UpdateDatabaseResponse Int Source #

The response's http status code.