AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ModifySnapshotCopyRetentionPeriodInput

import "github.com/aws/aws-sdk-go/service/redshift"

type ModifySnapshotCopyRetentionPeriodInput struct { ClusterIdentifier *string `type:"string" required:"true"` Manual *bool `type:"boolean"` RetentionPeriod *int64 `type:"integer" required:"true"` }

ClusterIdentifier

Type: *string

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.

ClusterIdentifier is a required field

Manual

Type: *bool

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

RetentionPeriod

Type: *int64

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.

RetentionPeriod is a required field

Method

GoString

func (s ModifySnapshotCopyRetentionPeriodInput) GoString() string

GoString returns the string representation

SetClusterIdentifier

func (s *ModifySnapshotCopyRetentionPeriodInput) SetClusterIdentifier(v string) *ModifySnapshotCopyRetentionPeriodInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetManual

func (s *ModifySnapshotCopyRetentionPeriodInput) SetManual(v bool) *ModifySnapshotCopyRetentionPeriodInput

SetManual sets the Manual field's value.

SetRetentionPeriod

func (s *ModifySnapshotCopyRetentionPeriodInput) SetRetentionPeriod(v int64) *ModifySnapshotCopyRetentionPeriodInput

SetRetentionPeriod sets the RetentionPeriod field's value.

String

func (s ModifySnapshotCopyRetentionPeriodInput) String() string

String returns the string representation

Validate

func (s *ModifySnapshotCopyRetentionPeriodInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: