software.amazon.awssdk.services.redshift.model

Interface ModifySnapshotCopyRetentionPeriodRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifySnapshotCopyRetentionPeriodRequest.Builder,ModifySnapshotCopyRetentionPeriodRequest>, RedshiftRequest.Builder, SdkBuilder<ModifySnapshotCopyRetentionPeriodRequest.Builder,ModifySnapshotCopyRetentionPeriodRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifySnapshotCopyRetentionPeriodRequest

public static interface ModifySnapshotCopyRetentionPeriodRequest.Builder
extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder<ModifySnapshotCopyRetentionPeriodRequest.Builder,ModifySnapshotCopyRetentionPeriodRequest>

Method Summary

Modifier and Type	Method and Description
ModifySnapshotCopyRetentionPeriodRequest.Builder	clusterIdentifier(String clusterIdentifier) 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.
ModifySnapshotCopyRetentionPeriodRequest.Builder	manual(Boolean manual) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
ModifySnapshotCopyRetentionPeriodRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ModifySnapshotCopyRetentionPeriodRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ModifySnapshotCopyRetentionPeriodRequest.Builder	retentionPeriod(Integer retentionPeriod) The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clusterIdentifier

ModifySnapshotCopyRetentionPeriodRequest.Builder clusterIdentifier(String clusterIdentifier)

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.

Parameters:

clusterIdentifier - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

retentionPeriod

ModifySnapshotCopyRetentionPeriodRequest.Builder retentionPeriod(Integer retentionPeriod)

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.

Parameters:

retentionPeriod - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

manual

ModifySnapshotCopyRetentionPeriodRequest.Builder manual(Boolean manual)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ModifySnapshotCopyRetentionPeriodRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ModifySnapshotCopyRetentionPeriodRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.