libZSservicesZSamazonka-neptuneZSamazonka-neptune
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Description

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

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

To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

Synopsis

Creating a Request

data ModifyDBClusterSnapshotAttribute Source #

See: newModifyDBClusterSnapshotAttribute smart constructor.

Constructors

ModifyDBClusterSnapshotAttribute' 

Fields

  • valuesToAdd :: Maybe [Text]

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

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

  • valuesToRemove :: Maybe [Text]

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

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

  • dbClusterSnapshotIdentifier :: Text

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

  • attributeName :: Text

    The name of the DB cluster snapshot attribute to modify.

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

Instances

Instances details
Eq ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Read ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Show ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Generic ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Associated Types

type Rep ModifyDBClusterSnapshotAttribute :: Type -> Type #

NFData ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Hashable ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

AWSRequest ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

ToHeaders ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

ToPath ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

ToQuery ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttribute = D1 ('MetaData "ModifyDBClusterSnapshotAttribute" "Amazonka.Neptune.ModifyDBClusterSnapshotAttribute" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.Neptune.ModifyDBClusterSnapshotAttribute

newModifyDBClusterSnapshotAttribute Source #

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 DB cluster snapshot attributes to add to the attribute specified by AttributeName.

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

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

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

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

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

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

Request Lenses

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

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

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

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

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

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

modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

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

modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text Source #

The name of the DB cluster snapshot attribute to modify.

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

Destructuring the Response

data ModifyDBClusterSnapshotAttributeResponse Source #

Instances

Instances details
Eq ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Read ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Show ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

Generic ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

NFData ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttributeResponse = D1 ('MetaData "ModifyDBClusterSnapshotAttributeResponse" "Amazonka.Neptune.ModifyDBClusterSnapshotAttribute" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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)))

Response Lenses