/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::ModifyDBClusterSnapshotAttribute

NAME

Paws::RDS::ModifyDBClusterSnapshotAttribute - Arguments for method ModifyDBClusterSnapshotAttribute on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method ModifyDBClusterSnapshotAttribute on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method ModifyDBClusterSnapshotAttribute.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBClusterSnapshotAttribute.

SYNOPSIS

  my $rds = Paws->service('RDS');
# To add or remove access to a manual DB cluster snapshot
# The following example gives two AWS accounts access to a manual DB cluster
# snapshot and ensures that the DB cluster snapshot is private by removing the
# value "all".
  my $ModifyDBClusterSnapshotAttributeResult =
    $rds->ModifyDBClusterSnapshotAttribute(
    'AttributeName'               => 'restore',
    'DBClusterSnapshotIdentifier' => 'manual-cluster-snapshot1',
    'ValuesToAdd'                 => [ 123451234512, 123456789012 ],
    'ValuesToRemove'              => ['all']
    );

  # Results:
  my $DBClusterSnapshotAttributesResult =
    $ModifyDBClusterSnapshotAttributeResult
    ->DBClusterSnapshotAttributesResult;

  # Returns a L<Paws::RDS::ModifyDBClusterSnapshotAttributeResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBClusterSnapshotAttribute

ATTRIBUTES

REQUIRED AttributeName => Str

The name of the DB cluster snapshot attribute to modify.

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

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

REQUIRED DBClusterSnapshotIdentifier => Str

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

ValuesToAdd => ArrayRef[Str|Undef]

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

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services 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 Amazon Web Services accounts.

ValuesToRemove => ArrayRef[Str|Undef]

A list of DB cluster 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 DB cluster 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 cluster 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 a manual DB cluster snapshot.

SEE ALSO

This class forms part of Paws, documenting arguments for method ModifyDBClusterSnapshotAttribute in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues