libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.ModifyClusterSnapshot

Description

Modifies the settings for a snapshot.

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

Synopsis

Creating a Request

data ModifyClusterSnapshot Source #

See: newModifyClusterSnapshot smart constructor.

Constructors

ModifyClusterSnapshot' 

Fields

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

  • force :: Maybe Bool

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

  • snapshotIdentifier :: Text

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

Instances

Instances details
Eq ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Methods

(==) :: ModifyClusterSnapshot -> ModifyClusterSnapshot -> Bool #

(/=) :: ModifyClusterSnapshot -> ModifyClusterSnapshot -> Bool #

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 #

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 #

NFData ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Methods

rnf :: ModifyClusterSnapshot -> () #

Hashable ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Methods

hashWithSalt :: Int -> ModifyClusterSnapshot -> Int #

hash :: ModifyClusterSnapshot -> Int #

AWSRequest ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Associated Types

type AWSResponse ModifyClusterSnapshot #

Methods

request :: ModifyClusterSnapshot -> Request ModifyClusterSnapshot #

response :: MonadResource m => Logger -> Service -> Proxy ModifyClusterSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyClusterSnapshot))) #

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 #

type Rep ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

type Rep ModifyClusterSnapshot = D1 ('MetaData "ModifyClusterSnapshot" "Amazonka.Redshift.ModifyClusterSnapshot" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "ModifyClusterSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "manualSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "snapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ModifyClusterSnapshot Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

type AWSResponse ModifyClusterSnapshot = ModifyClusterSnapshotResponse

newModifyClusterSnapshot Source #

Arguments

:: Text

$sel:snapshotIdentifier: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:manualSnapshotRetentionPeriod: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.

$sel:force:ModifyClusterSnapshot', modifyClusterSnapshot_force - A Boolean option to override an exception if the retention period has already passed.

$sel:snapshotIdentifier:ModifyClusterSnapshot', modifyClusterSnapshot_snapshotIdentifier - The identifier of the snapshot whose setting you want to modify.

Request Lenses

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_force :: Lens' ModifyClusterSnapshot (Maybe Bool) Source #

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

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

Instances

Instances details
Eq ModifyClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Methods

(==) :: ModifyClusterSnapshotResponse -> ModifyClusterSnapshotResponse -> Bool #

(/=) :: ModifyClusterSnapshotResponse -> ModifyClusterSnapshotResponse -> Bool #

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 #

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 #

NFData ModifyClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

Methods

rnf :: ModifyClusterSnapshotResponse -> () #

type Rep ModifyClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyClusterSnapshot

type Rep ModifyClusterSnapshotResponse = D1 ('MetaData "ModifyClusterSnapshotResponse" "Amazonka.Redshift.ModifyClusterSnapshot" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" '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.