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.DocumentDB.ModifyDBClusterSnapshotAttribute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

Synopsis

Creating a Request

data ModifyDBClusterSnapshotAttribute Source #

Represents the input to ModifyDBClusterSnapshotAttribute.

See: newModifyDBClusterSnapshotAttribute smart constructor.

Constructors

ModifyDBClusterSnapshotAttribute'

Fields

valuesToAdd :: Maybe [Text]
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.
valuesToRemove :: Maybe [Text]
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
dbClusterSnapshotIdentifier :: Text
The identifier for the cluster snapshot to modify the attributes for.
attributeName :: Text
The name of the cluster snapshot attribute to modify.
To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.

Instances

Instances details

Eq ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods (==) :: ModifyDBClusterSnapshotAttribute -> ModifyDBClusterSnapshotAttribute -> Bool # (/=) :: ModifyDBClusterSnapshotAttribute -> ModifyDBClusterSnapshotAttribute -> Bool #
Read ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods readsPrec :: Int -> ReadS ModifyDBClusterSnapshotAttribute # readList :: ReadS [ModifyDBClusterSnapshotAttribute] # readPrec :: ReadPrec ModifyDBClusterSnapshotAttribute # readListPrec :: ReadPrec [ModifyDBClusterSnapshotAttribute] #
Show ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods showsPrec :: Int -> ModifyDBClusterSnapshotAttribute -> ShowS # show :: ModifyDBClusterSnapshotAttribute -> String # showList :: [ModifyDBClusterSnapshotAttribute] -> ShowS #
Generic ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Associated Types type Rep ModifyDBClusterSnapshotAttribute :: Type -> Type # Methods from :: ModifyDBClusterSnapshotAttribute -> Rep ModifyDBClusterSnapshotAttribute x # to :: Rep ModifyDBClusterSnapshotAttribute x -> ModifyDBClusterSnapshotAttribute #
NFData ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods rnf :: ModifyDBClusterSnapshotAttribute -> () #
Hashable ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods hashWithSalt :: Int -> ModifyDBClusterSnapshotAttribute -> Int # hash :: ModifyDBClusterSnapshotAttribute -> Int #
AWSRequest ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Associated Types type AWSResponse ModifyDBClusterSnapshotAttribute # Methods request :: ModifyDBClusterSnapshotAttribute -> Request ModifyDBClusterSnapshotAttribute # response :: MonadResource m => Logger -> Service -> Proxy ModifyDBClusterSnapshotAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBClusterSnapshotAttribute))) #
ToHeaders ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods toHeaders :: ModifyDBClusterSnapshotAttribute -> [Header] #
ToPath ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods toPath :: ModifyDBClusterSnapshotAttribute -> ByteString #
ToQuery ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods toQuery :: ModifyDBClusterSnapshotAttribute -> QueryString #
type Rep ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute type Rep ModifyDBClusterSnapshotAttribute = D1 ('MetaData "ModifyDBClusterSnapshotAttribute" "Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "ModifyDBClusterSnapshotAttribute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "valuesToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "valuesToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ModifyDBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute type AWSResponse ModifyDBClusterSnapshotAttribute = ModifyDBClusterSnapshotAttributeResponse

newModifyDBClusterSnapshotAttribute Source #

Arguments

:: Text	`$sel:dbClusterSnapshotIdentifier:ModifyDBClusterSnapshotAttribute'`
-> Text	`$sel:attributeName:ModifyDBClusterSnapshotAttribute'`
-> ModifyDBClusterSnapshotAttribute

Create a value of ModifyDBClusterSnapshotAttribute 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:valuesToAdd:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_valuesToAdd - A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.

$sel:valuesToRemove:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_valuesToRemove - A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

$sel:dbClusterSnapshotIdentifier:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier - The identifier for the cluster snapshot to modify the attributes for.

$sel:attributeName:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_attributeName - The name of the cluster snapshot attribute to modify.

To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.

Request Lenses

modifyDBClusterSnapshotAttribute_valuesToAdd :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text]) Source #

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.

modifyDBClusterSnapshotAttribute_valuesToRemove :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text]) Source #

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The identifier for the cluster snapshot to modify the attributes for.

modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The name of the cluster snapshot attribute to modify.

To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.

Destructuring the Response

data ModifyDBClusterSnapshotAttributeResponse Source #

See: newModifyDBClusterSnapshotAttributeResponse smart constructor.

Constructors

ModifyDBClusterSnapshotAttributeResponse'
Fields dbClusterSnapshotAttributesResult :: Maybe DBClusterSnapshotAttributesResult httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods (==) :: ModifyDBClusterSnapshotAttributeResponse -> ModifyDBClusterSnapshotAttributeResponse -> Bool # (/=) :: ModifyDBClusterSnapshotAttributeResponse -> ModifyDBClusterSnapshotAttributeResponse -> Bool #
Read ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods readsPrec :: Int -> ReadS ModifyDBClusterSnapshotAttributeResponse # readList :: ReadS [ModifyDBClusterSnapshotAttributeResponse] # readPrec :: ReadPrec ModifyDBClusterSnapshotAttributeResponse # readListPrec :: ReadPrec [ModifyDBClusterSnapshotAttributeResponse] #
Show ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods showsPrec :: Int -> ModifyDBClusterSnapshotAttributeResponse -> ShowS # show :: ModifyDBClusterSnapshotAttributeResponse -> String # showList :: [ModifyDBClusterSnapshotAttributeResponse] -> ShowS #
Generic ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Associated Types type Rep ModifyDBClusterSnapshotAttributeResponse :: Type -> Type # Methods from :: ModifyDBClusterSnapshotAttributeResponse -> Rep ModifyDBClusterSnapshotAttributeResponse x # to :: Rep ModifyDBClusterSnapshotAttributeResponse x -> ModifyDBClusterSnapshotAttributeResponse #
NFData ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute Methods rnf :: ModifyDBClusterSnapshotAttributeResponse -> () #
type Rep ModifyDBClusterSnapshotAttributeResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute type Rep ModifyDBClusterSnapshotAttributeResponse = D1 ('MetaData "ModifyDBClusterSnapshotAttributeResponse" "Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "ModifyDBClusterSnapshotAttributeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributesResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshotAttributesResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBClusterSnapshotAttributeResponse Source #

Arguments

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

Create a value of ModifyDBClusterSnapshotAttributeResponse 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:dbClusterSnapshotAttributesResult:ModifyDBClusterSnapshotAttributeResponse', modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult - Undocumented member.

$sel:httpStatus:ModifyDBClusterSnapshotAttributeResponse', modifyDBClusterSnapshotAttributeResponse_httpStatus - The response's http status code.

Response Lenses

modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult :: Lens' ModifyDBClusterSnapshotAttributeResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

modifyDBClusterSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBClusterSnapshotAttributeResponse Int Source #

The response's http status code.