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.Backup.CreateBackupVault

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Synopsis

data CreateBackupVault = CreateBackupVault' {
- creatorRequestId :: Maybe Text
- encryptionKeyArn :: Maybe Text
- backupVaultTags :: Maybe (Sensitive (HashMap Text Text))
- backupVaultName :: Text
}
newCreateBackupVault :: Text -> CreateBackupVault
createBackupVault_creatorRequestId :: Lens' CreateBackupVault (Maybe Text)
createBackupVault_encryptionKeyArn :: Lens' CreateBackupVault (Maybe Text)
createBackupVault_backupVaultTags :: Lens' CreateBackupVault (Maybe (HashMap Text Text))
createBackupVault_backupVaultName :: Lens' CreateBackupVault Text
data CreateBackupVaultResponse = CreateBackupVaultResponse' {
- backupVaultArn :: Maybe Text
- creationDate :: Maybe POSIX
- backupVaultName :: Maybe Text
- httpStatus :: Int
}
newCreateBackupVaultResponse :: Int -> CreateBackupVaultResponse
createBackupVaultResponse_backupVaultArn :: Lens' CreateBackupVaultResponse (Maybe Text)
createBackupVaultResponse_creationDate :: Lens' CreateBackupVaultResponse (Maybe UTCTime)
createBackupVaultResponse_backupVaultName :: Lens' CreateBackupVaultResponse (Maybe Text)
createBackupVaultResponse_httpStatus :: Lens' CreateBackupVaultResponse Int

Creating a Request

data CreateBackupVault Source #

See: newCreateBackupVault smart constructor.

Constructors

CreateBackupVault'

Fields

creatorRequestId :: Maybe Text
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
encryptionKeyArn :: Maybe Text
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
backupVaultTags :: Maybe (Sensitive (HashMap Text Text))
Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
backupVaultName :: Text
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

Instances

Instances details

Eq CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods (==) :: CreateBackupVault -> CreateBackupVault -> Bool # (/=) :: CreateBackupVault -> CreateBackupVault -> Bool #
Show CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods showsPrec :: Int -> CreateBackupVault -> ShowS # show :: CreateBackupVault -> String # showList :: [CreateBackupVault] -> ShowS #
Generic CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Associated Types type Rep CreateBackupVault :: Type -> Type # Methods from :: CreateBackupVault -> Rep CreateBackupVault x # to :: Rep CreateBackupVault x -> CreateBackupVault #
NFData CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods rnf :: CreateBackupVault -> () #
Hashable CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods hashWithSalt :: Int -> CreateBackupVault -> Int # hash :: CreateBackupVault -> Int #
ToJSON CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods toJSON :: CreateBackupVault -> Value # toEncoding :: CreateBackupVault -> Encoding # toJSONList :: [CreateBackupVault] -> Value # toEncodingList :: [CreateBackupVault] -> Encoding #
AWSRequest CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Associated Types type AWSResponse CreateBackupVault # Methods request :: CreateBackupVault -> Request CreateBackupVault # response :: MonadResource m => Logger -> Service -> Proxy CreateBackupVault -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackupVault))) #
ToHeaders CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods toHeaders :: CreateBackupVault -> [Header] #
ToPath CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods toPath :: CreateBackupVault -> ByteString #
ToQuery CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods toQuery :: CreateBackupVault -> QueryString #
type Rep CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault type Rep CreateBackupVault = D1 ('MetaData "CreateBackupVault" "Amazonka.Backup.CreateBackupVault" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "CreateBackupVault'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "backupVaultTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateBackupVault Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault type AWSResponse CreateBackupVault = CreateBackupVaultResponse

newCreateBackupVault Source #

Arguments

:: Text	`$sel:backupVaultName:CreateBackupVault'`
-> CreateBackupVault

Create a value of CreateBackupVault 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:creatorRequestId:CreateBackupVault', createBackupVault_creatorRequestId - A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

$sel:encryptionKeyArn:CreateBackupVault', createBackupVault_encryptionKeyArn - The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

$sel:backupVaultTags:CreateBackupVault', createBackupVault_backupVaultTags - Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

$sel:backupVaultName:CreateBackupVault', createBackupVault_backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

Request Lenses

createBackupVault_creatorRequestId :: Lens' CreateBackupVault (Maybe Text) Source #

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

createBackupVault_encryptionKeyArn :: Lens' CreateBackupVault (Maybe Text) Source #

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

createBackupVault_backupVaultTags :: Lens' CreateBackupVault (Maybe (HashMap Text Text)) Source #

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

createBackupVault_backupVaultName :: Lens' CreateBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

Destructuring the Response

data CreateBackupVaultResponse Source #

See: newCreateBackupVaultResponse smart constructor.

Constructors

CreateBackupVaultResponse'

Fields

backupVaultArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
creationDate :: Maybe POSIX
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
backupVaultName :: Maybe Text
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods (==) :: CreateBackupVaultResponse -> CreateBackupVaultResponse -> Bool # (/=) :: CreateBackupVaultResponse -> CreateBackupVaultResponse -> Bool #
Read CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods readsPrec :: Int -> ReadS CreateBackupVaultResponse # readList :: ReadS [CreateBackupVaultResponse] # readPrec :: ReadPrec CreateBackupVaultResponse # readListPrec :: ReadPrec [CreateBackupVaultResponse] #
Show CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods showsPrec :: Int -> CreateBackupVaultResponse -> ShowS # show :: CreateBackupVaultResponse -> String # showList :: [CreateBackupVaultResponse] -> ShowS #
Generic CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Associated Types type Rep CreateBackupVaultResponse :: Type -> Type # Methods from :: CreateBackupVaultResponse -> Rep CreateBackupVaultResponse x # to :: Rep CreateBackupVaultResponse x -> CreateBackupVaultResponse #
NFData CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault Methods rnf :: CreateBackupVaultResponse -> () #
type Rep CreateBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.CreateBackupVault type Rep CreateBackupVaultResponse = D1 ('MetaData "CreateBackupVaultResponse" "Amazonka.Backup.CreateBackupVault" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "CreateBackupVaultResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupVaultArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateBackupVaultResponse Source #

Arguments

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

Create a value of CreateBackupVaultResponse 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:backupVaultArn:CreateBackupVaultResponse', createBackupVaultResponse_backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

$sel:creationDate:CreateBackupVaultResponse', createBackupVaultResponse_creationDate - The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:backupVaultName:CreateBackupVault', createBackupVaultResponse_backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

$sel:httpStatus:CreateBackupVaultResponse', createBackupVaultResponse_httpStatus - The response's http status code.

Response Lenses

createBackupVaultResponse_backupVaultArn :: Lens' CreateBackupVaultResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

createBackupVaultResponse_creationDate :: Lens' CreateBackupVaultResponse (Maybe UTCTime) Source #

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

createBackupVaultResponse_backupVaultName :: Lens' CreateBackupVaultResponse (Maybe Text) Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

createBackupVaultResponse_httpStatus :: Lens' CreateBackupVaultResponse Int Source #

The response's http status code.