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 |
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
- data ModifyDBClusterSnapshotAttribute = ModifyDBClusterSnapshotAttribute' {}
- newModifyDBClusterSnapshotAttribute :: Text -> Text -> ModifyDBClusterSnapshotAttribute
- modifyDBClusterSnapshotAttribute_valuesToAdd :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text])
- modifyDBClusterSnapshotAttribute_valuesToRemove :: Lens' ModifyDBClusterSnapshotAttribute (Maybe [Text])
- modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier :: Lens' ModifyDBClusterSnapshotAttribute Text
- modifyDBClusterSnapshotAttribute_attributeName :: Lens' ModifyDBClusterSnapshotAttribute Text
- data ModifyDBClusterSnapshotAttributeResponse = ModifyDBClusterSnapshotAttributeResponse' {}
- newModifyDBClusterSnapshotAttributeResponse :: Int -> ModifyDBClusterSnapshotAttributeResponse
- modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult :: Lens' ModifyDBClusterSnapshotAttributeResponse (Maybe DBClusterSnapshotAttributesResult)
- modifyDBClusterSnapshotAttributeResponse_httpStatus :: Lens' ModifyDBClusterSnapshotAttributeResponse Int
Creating a Request
data ModifyDBClusterSnapshotAttribute Source #
See: newModifyDBClusterSnapshotAttribute
smart constructor.
ModifyDBClusterSnapshotAttribute' | |
|
Instances
newModifyDBClusterSnapshotAttribute Source #
:: Text |
|
-> Text | |
-> 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 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 #
See: newModifyDBClusterSnapshotAttributeResponse
smart constructor.
ModifyDBClusterSnapshotAttributeResponse' | |
|
Instances
newModifyDBClusterSnapshotAttributeResponse Source #
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.