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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Synopsis

data CreateClusterSnapshot = CreateClusterSnapshot' {
- manualSnapshotRetentionPeriod :: Maybe Int
- tags :: Maybe [Tag]
- snapshotIdentifier :: Text
- clusterIdentifier :: Text
}
newCreateClusterSnapshot :: Text -> Text -> CreateClusterSnapshot
createClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' CreateClusterSnapshot (Maybe Int)
createClusterSnapshot_tags :: Lens' CreateClusterSnapshot (Maybe [Tag])
createClusterSnapshot_snapshotIdentifier :: Lens' CreateClusterSnapshot Text
createClusterSnapshot_clusterIdentifier :: Lens' CreateClusterSnapshot Text
data CreateClusterSnapshotResponse = CreateClusterSnapshotResponse' {
- snapshot :: Maybe Snapshot
- httpStatus :: Int
}
newCreateClusterSnapshotResponse :: Int -> CreateClusterSnapshotResponse
createClusterSnapshotResponse_snapshot :: Lens' CreateClusterSnapshotResponse (Maybe Snapshot)
createClusterSnapshotResponse_httpStatus :: Lens' CreateClusterSnapshotResponse Int

Creating a Request

data CreateClusterSnapshot Source #

See: newCreateClusterSnapshot smart constructor.

Constructors

CreateClusterSnapshot'

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.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
tags :: Maybe [Tag]
A list of tag instances.
snapshotIdentifier :: Text
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
Constraints:
- Cannot be null, empty, or blank
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
clusterIdentifier :: Text
The cluster identifier for which you want a snapshot.

Instances

Instances details

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

newCreateClusterSnapshot Source #

Arguments

:: Text	`$sel:snapshotIdentifier:CreateClusterSnapshot'`
-> Text	`$sel:clusterIdentifier:CreateClusterSnapshot'`
-> CreateClusterSnapshot

Create a value of CreateClusterSnapshot 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:CreateClusterSnapshot', createClusterSnapshot_manualSnapshotRetentionPeriod - The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

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

The default value is -1.

$sel:tags:CreateClusterSnapshot', createClusterSnapshot_tags - A list of tag instances.

$sel:snapshotIdentifier:CreateClusterSnapshot', createClusterSnapshot_snapshotIdentifier - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

$sel:clusterIdentifier:CreateClusterSnapshot', createClusterSnapshot_clusterIdentifier - The cluster identifier for which you want a snapshot.

Request Lenses

createClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' CreateClusterSnapshot (Maybe Int) Source #

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

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

The default value is -1.

createClusterSnapshot_tags :: Lens' CreateClusterSnapshot (Maybe [Tag]) Source #

A list of tag instances.

createClusterSnapshot_snapshotIdentifier :: Lens' CreateClusterSnapshot Text Source #

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

createClusterSnapshot_clusterIdentifier :: Lens' CreateClusterSnapshot Text Source #

The cluster identifier for which you want a snapshot.

Destructuring the Response

data CreateClusterSnapshotResponse Source #

See: newCreateClusterSnapshotResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateClusterSnapshotResponse Source #

Arguments

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

Create a value of CreateClusterSnapshotResponse 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:CreateClusterSnapshotResponse', createClusterSnapshotResponse_snapshot - Undocumented member.

$sel:httpStatus:CreateClusterSnapshotResponse', createClusterSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

createClusterSnapshotResponse_snapshot :: Lens' CreateClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

createClusterSnapshotResponse_httpStatus :: Lens' CreateClusterSnapshotResponse Int Source #

The response's http status code.