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.RDS.ModifyDBSnapshotAttribute

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 DB snapshot.

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.

Synopsis

Creating a Request

data ModifyDBSnapshotAttribute Source #

See: newModifyDBSnapshotAttribute smart constructor.

Constructors

ModifyDBSnapshotAttribute'

Fields

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

Instances

Instances details

Eq ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods (==) :: ModifyDBSnapshotAttribute -> ModifyDBSnapshotAttribute -> Bool # (/=) :: ModifyDBSnapshotAttribute -> ModifyDBSnapshotAttribute -> Bool #
Read ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods readsPrec :: Int -> ReadS ModifyDBSnapshotAttribute # readList :: ReadS [ModifyDBSnapshotAttribute] # readPrec :: ReadPrec ModifyDBSnapshotAttribute # readListPrec :: ReadPrec [ModifyDBSnapshotAttribute] #
Show ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods showsPrec :: Int -> ModifyDBSnapshotAttribute -> ShowS # show :: ModifyDBSnapshotAttribute -> String # showList :: [ModifyDBSnapshotAttribute] -> ShowS #
Generic ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Associated Types type Rep ModifyDBSnapshotAttribute :: Type -> Type # Methods from :: ModifyDBSnapshotAttribute -> Rep ModifyDBSnapshotAttribute x # to :: Rep ModifyDBSnapshotAttribute x -> ModifyDBSnapshotAttribute #
NFData ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods rnf :: ModifyDBSnapshotAttribute -> () #
Hashable ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods hashWithSalt :: Int -> ModifyDBSnapshotAttribute -> Int # hash :: ModifyDBSnapshotAttribute -> Int #
AWSRequest ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Associated Types type AWSResponse ModifyDBSnapshotAttribute # Methods request :: ModifyDBSnapshotAttribute -> Request ModifyDBSnapshotAttribute # response :: MonadResource m => Logger -> Service -> Proxy ModifyDBSnapshotAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBSnapshotAttribute))) #
ToHeaders ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods toHeaders :: ModifyDBSnapshotAttribute -> [Header] #
ToPath ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods toPath :: ModifyDBSnapshotAttribute -> ByteString #
ToQuery ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute Methods toQuery :: ModifyDBSnapshotAttribute -> QueryString #
type Rep ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute type Rep ModifyDBSnapshotAttribute = D1 ('MetaData "ModifyDBSnapshotAttribute" "Amazonka.RDS.ModifyDBSnapshotAttribute" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyDBSnapshotAttribute'" '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 "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ModifyDBSnapshotAttribute Source #
Instance details Defined in Amazonka.RDS.ModifyDBSnapshotAttribute type AWSResponse ModifyDBSnapshotAttribute = ModifyDBSnapshotAttributeResponse

newModifyDBSnapshotAttribute Source #

Arguments

:: Text	`$sel:dbSnapshotIdentifier:ModifyDBSnapshotAttribute'`
-> Text	`$sel:attributeName:ModifyDBSnapshotAttribute'`
-> ModifyDBSnapshotAttribute

Create a value of ModifyDBSnapshotAttribute 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:ModifyDBSnapshotAttribute', modifyDBSnapshotAttribute_valuesToAdd - A list of DB snapshot attributes to add to the attribute specified by AttributeName.

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

$sel:valuesToRemove:ModifyDBSnapshotAttribute', modifyDBSnapshotAttribute_valuesToRemove - A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

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

$sel:dbSnapshotIdentifier:ModifyDBSnapshotAttribute', modifyDBSnapshotAttribute_dbSnapshotIdentifier - The identifier for the DB snapshot to modify the attributes for.

$sel:attributeName:ModifyDBSnapshotAttribute', modifyDBSnapshotAttribute_attributeName - The name of the DB snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API action.

Request Lenses

modifyDBSnapshotAttribute_valuesToAdd :: Lens' ModifyDBSnapshotAttribute (Maybe [Text]) Source #

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

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

modifyDBSnapshotAttribute_valuesToRemove :: Lens' ModifyDBSnapshotAttribute (Maybe [Text]) Source #

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

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

modifyDBSnapshotAttribute_dbSnapshotIdentifier :: Lens' ModifyDBSnapshotAttribute Text Source #

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

modifyDBSnapshotAttribute_attributeName :: Lens' ModifyDBSnapshotAttribute Text Source #

The name of the DB snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API action.

Destructuring the Response

data ModifyDBSnapshotAttributeResponse Source #

See: newModifyDBSnapshotAttributeResponse smart constructor.

Constructors

ModifyDBSnapshotAttributeResponse'
Fields dbSnapshotAttributesResult :: Maybe DBSnapshotAttributesResult httpStatus :: Int The response's http status code.

Instances

Instances details

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

newModifyDBSnapshotAttributeResponse Source #

Arguments

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

Create a value of ModifyDBSnapshotAttributeResponse 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:dbSnapshotAttributesResult:ModifyDBSnapshotAttributeResponse', modifyDBSnapshotAttributeResponse_dbSnapshotAttributesResult - Undocumented member.

$sel:httpStatus:ModifyDBSnapshotAttributeResponse', modifyDBSnapshotAttributeResponse_httpStatus - The response's http status code.

Response Lenses

modifyDBSnapshotAttributeResponse_dbSnapshotAttributesResult :: Lens' ModifyDBSnapshotAttributeResponse (Maybe DBSnapshotAttributesResult) Source #

Undocumented member.

modifyDBSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBSnapshotAttributeResponse Int Source #

The response's http status code.