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

Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Synopsis

Creating a Request

data ModifySnapshotCopyRetentionPeriod Source #

See: newModifySnapshotCopyRetentionPeriod smart constructor.

Constructors

ModifySnapshotCopyRetentionPeriod'

Fields

manual :: Maybe Bool
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
clusterIdentifier :: Text
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 Amazon Web Services Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
retentionPeriod :: Int
The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services 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.

Instances

Instances details

Eq ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods (==) :: ModifySnapshotCopyRetentionPeriod -> ModifySnapshotCopyRetentionPeriod -> Bool # (/=) :: ModifySnapshotCopyRetentionPeriod -> ModifySnapshotCopyRetentionPeriod -> Bool #
Read ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods readsPrec :: Int -> ReadS ModifySnapshotCopyRetentionPeriod # readList :: ReadS [ModifySnapshotCopyRetentionPeriod] # readPrec :: ReadPrec ModifySnapshotCopyRetentionPeriod # readListPrec :: ReadPrec [ModifySnapshotCopyRetentionPeriod] #
Show ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods showsPrec :: Int -> ModifySnapshotCopyRetentionPeriod -> ShowS # show :: ModifySnapshotCopyRetentionPeriod -> String # showList :: [ModifySnapshotCopyRetentionPeriod] -> ShowS #
Generic ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Associated Types type Rep ModifySnapshotCopyRetentionPeriod :: Type -> Type # Methods from :: ModifySnapshotCopyRetentionPeriod -> Rep ModifySnapshotCopyRetentionPeriod x # to :: Rep ModifySnapshotCopyRetentionPeriod x -> ModifySnapshotCopyRetentionPeriod #
NFData ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods rnf :: ModifySnapshotCopyRetentionPeriod -> () #
Hashable ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods hashWithSalt :: Int -> ModifySnapshotCopyRetentionPeriod -> Int # hash :: ModifySnapshotCopyRetentionPeriod -> Int #
AWSRequest ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Associated Types type AWSResponse ModifySnapshotCopyRetentionPeriod # Methods request :: ModifySnapshotCopyRetentionPeriod -> Request ModifySnapshotCopyRetentionPeriod # response :: MonadResource m => Logger -> Service -> Proxy ModifySnapshotCopyRetentionPeriod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifySnapshotCopyRetentionPeriod))) #
ToHeaders ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods toHeaders :: ModifySnapshotCopyRetentionPeriod -> [Header] #
ToPath ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods toPath :: ModifySnapshotCopyRetentionPeriod -> ByteString #
ToQuery ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods toQuery :: ModifySnapshotCopyRetentionPeriod -> QueryString #
type Rep ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod type Rep ModifySnapshotCopyRetentionPeriod = D1 ('MetaData "ModifySnapshotCopyRetentionPeriod" "Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ModifySnapshotCopyRetentionPeriod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "manual") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))
type AWSResponse ModifySnapshotCopyRetentionPeriod Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod type AWSResponse ModifySnapshotCopyRetentionPeriod = ModifySnapshotCopyRetentionPeriodResponse

newModifySnapshotCopyRetentionPeriod Source #

Arguments

:: Text	`$sel:clusterIdentifier:ModifySnapshotCopyRetentionPeriod'`
-> Int	`$sel:retentionPeriod:ModifySnapshotCopyRetentionPeriod'`
-> ModifySnapshotCopyRetentionPeriod

Create a value of ModifySnapshotCopyRetentionPeriod 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:manual:ModifySnapshotCopyRetentionPeriod', modifySnapshotCopyRetentionPeriod_manual - Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

$sel:clusterIdentifier:ModifySnapshotCopyRetentionPeriod', modifySnapshotCopyRetentionPeriod_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 Amazon Web Services Region.

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

$sel:retentionPeriod:ModifySnapshotCopyRetentionPeriod', modifySnapshotCopyRetentionPeriod_retentionPeriod - The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services 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.

Request Lenses

modifySnapshotCopyRetentionPeriod_manual :: Lens' ModifySnapshotCopyRetentionPeriod (Maybe Bool) Source #

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

modifySnapshotCopyRetentionPeriod_clusterIdentifier :: Lens' ModifySnapshotCopyRetentionPeriod Text Source #

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 Amazon Web Services Region.

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

modifySnapshotCopyRetentionPeriod_retentionPeriod :: Lens' ModifySnapshotCopyRetentionPeriod Int Source #

The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services 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.

Destructuring the Response

data ModifySnapshotCopyRetentionPeriodResponse Source #

See: newModifySnapshotCopyRetentionPeriodResponse smart constructor.

Constructors

ModifySnapshotCopyRetentionPeriodResponse'
Fields cluster :: Maybe Cluster httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods (==) :: ModifySnapshotCopyRetentionPeriodResponse -> ModifySnapshotCopyRetentionPeriodResponse -> Bool # (/=) :: ModifySnapshotCopyRetentionPeriodResponse -> ModifySnapshotCopyRetentionPeriodResponse -> Bool #
Read ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods readsPrec :: Int -> ReadS ModifySnapshotCopyRetentionPeriodResponse # readList :: ReadS [ModifySnapshotCopyRetentionPeriodResponse] # readPrec :: ReadPrec ModifySnapshotCopyRetentionPeriodResponse # readListPrec :: ReadPrec [ModifySnapshotCopyRetentionPeriodResponse] #
Show ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods showsPrec :: Int -> ModifySnapshotCopyRetentionPeriodResponse -> ShowS # show :: ModifySnapshotCopyRetentionPeriodResponse -> String # showList :: [ModifySnapshotCopyRetentionPeriodResponse] -> ShowS #
Generic ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Associated Types type Rep ModifySnapshotCopyRetentionPeriodResponse :: Type -> Type # Methods from :: ModifySnapshotCopyRetentionPeriodResponse -> Rep ModifySnapshotCopyRetentionPeriodResponse x # to :: Rep ModifySnapshotCopyRetentionPeriodResponse x -> ModifySnapshotCopyRetentionPeriodResponse #
NFData ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod Methods rnf :: ModifySnapshotCopyRetentionPeriodResponse -> () #
type Rep ModifySnapshotCopyRetentionPeriodResponse Source #
Instance details Defined in Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod type Rep ModifySnapshotCopyRetentionPeriodResponse = D1 ('MetaData "ModifySnapshotCopyRetentionPeriodResponse" "Amazonka.Redshift.ModifySnapshotCopyRetentionPeriod" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ModifySnapshotCopyRetentionPeriodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifySnapshotCopyRetentionPeriodResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifySnapshotCopyRetentionPeriodResponse'`
-> ModifySnapshotCopyRetentionPeriodResponse

Create a value of ModifySnapshotCopyRetentionPeriodResponse 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:cluster:ModifySnapshotCopyRetentionPeriodResponse', modifySnapshotCopyRetentionPeriodResponse_cluster - Undocumented member.

$sel:httpStatus:ModifySnapshotCopyRetentionPeriodResponse', modifySnapshotCopyRetentionPeriodResponse_httpStatus - The response's http status code.

Response Lenses

modifySnapshotCopyRetentionPeriodResponse_cluster :: Lens' ModifySnapshotCopyRetentionPeriodResponse (Maybe Cluster) Source #

Undocumented member.

modifySnapshotCopyRetentionPeriodResponse_httpStatus :: Lens' ModifySnapshotCopyRetentionPeriodResponse Int Source #

The response's http status code.