Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.ModifyClusterSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Creating a Request

data ModifyClusterSnapshot Source #

See: newModifyClusterSnapshot smart constructor.

Constructors

ModifyClusterSnapshot'

Fields

force :: Maybe Bool
A Boolean option to override an exception if the retention period has already passed.
manualSnapshotRetentionPeriod :: Maybe Int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
snapshotIdentifier :: Text
The identifier of the snapshot whose setting you want to modify.

Instances

Instances details

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

newModifyClusterSnapshot Source #

Arguments

:: Text	`ModifyClusterSnapshot`
-> ModifyClusterSnapshot

Create a value of ModifyClusterSnapshot 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:force:ModifyClusterSnapshot', modifyClusterSnapshot_force - A Boolean option to override an exception if the retention period has already passed.

ModifyClusterSnapshot, modifyClusterSnapshot_manualSnapshotRetentionPeriod - The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

The value must be either -1 or an integer between 1 and 3,653.

ModifyClusterSnapshot, modifyClusterSnapshot_snapshotIdentifier - The identifier of the snapshot whose setting you want to modify.

Request Lenses

modifyClusterSnapshot_force :: Lens' ModifyClusterSnapshot (Maybe Bool) Source #

A Boolean option to override an exception if the retention period has already passed.

modifyClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' ModifyClusterSnapshot (Maybe Int) Source #

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

The value must be either -1 or an integer between 1 and 3,653.

modifyClusterSnapshot_snapshotIdentifier :: Lens' ModifyClusterSnapshot Text Source #

The identifier of the snapshot whose setting you want to modify.

Destructuring the Response

data ModifyClusterSnapshotResponse Source #

See: newModifyClusterSnapshotResponse smart constructor.

Constructors

ModifyClusterSnapshotResponse'
Fields snapshot :: Maybe Snapshot httpStatus :: Int The response's http status code.

Instances

Instances details

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

newModifyClusterSnapshotResponse Source #

Arguments

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

Create a value of ModifyClusterSnapshotResponse 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:snapshot:ModifyClusterSnapshotResponse', modifyClusterSnapshotResponse_snapshot - Undocumented member.

$sel:httpStatus:ModifyClusterSnapshotResponse', modifyClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

modifyClusterSnapshotResponse_snapshot :: Lens' ModifyClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

modifyClusterSnapshotResponse_httpStatus :: Lens' ModifyClusterSnapshotResponse Int Source #

The response's http status code.