/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::ModifySnapshotCopyRetentionPeriod

NAME

Paws::RedShift::ModifySnapshotCopyRetentionPeriod - Arguments for method ModifySnapshotCopyRetentionPeriod on Paws::RedShift

DESCRIPTION

This class represents the parameters used for calling the method ModifySnapshotCopyRetentionPeriod on the Amazon Redshift service. Use the attributes of this class as arguments to method ModifySnapshotCopyRetentionPeriod.

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

SYNOPSIS

  my $redshift = Paws->service('RedShift');
  my $ModifySnapshotCopyRetentionPeriodResult =
    $redshift->ModifySnapshotCopyRetentionPeriod(
    ClusterIdentifier => 'MyString',
    RetentionPeriod   => 1,
    Manual            => 1,            # OPTIONAL
    );

  # Results:
  my $Cluster = $ModifySnapshotCopyRetentionPeriodResult->Cluster;

# Returns a L<Paws::RedShift::ModifySnapshotCopyRetentionPeriodResult> 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/redshift/ModifySnapshotCopyRetentionPeriod

ATTRIBUTES

REQUIRED ClusterIdentifier => Str

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Manual => Bool

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

REQUIRED RetentionPeriod => Int

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

SEE ALSO

This class forms part of Paws, documenting arguments for method ModifySnapshotCopyRetentionPeriod in Paws::RedShift

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