libZSservicesZSamazonka-elasticacheZSamazonka-elasticache
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.ElastiCache.CreateSnapshot

Description

Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

Synopsis

Creating a Request

data CreateSnapshot Source #

Represents the input of a CreateSnapshot operation.

See: newCreateSnapshot smart constructor.

Constructors

CreateSnapshot' 

Fields

  • cacheClusterId :: Maybe Text

    The identifier of an existing cluster. The snapshot is created from this cluster.

  • kmsKeyId :: Maybe Text

    The ID of the KMS key used to encrypt the snapshot.

  • replicationGroupId :: Maybe Text

    The identifier of an existing replication group. The snapshot is created from this replication group.

  • tags :: Maybe [Tag]

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

  • snapshotName :: Text

    A name for the snapshot being created.

Instances

Instances details
Eq CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

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

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

Read CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

readsPrec :: Int -> ReadS CreateSnapshot #

readList :: ReadS [CreateSnapshot] #

readPrec :: ReadPrec CreateSnapshot #

readListPrec :: ReadPrec [CreateSnapshot] #

Show CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

showsPrec :: Int -> CreateSnapshot -> ShowS #

show :: CreateSnapshot -> String #

showList :: [CreateSnapshot] -> ShowS #

Generic CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Associated Types

type Rep CreateSnapshot :: Type -> Type #

Methods

from :: CreateSnapshot -> Rep CreateSnapshot x #

to :: Rep CreateSnapshot x -> CreateSnapshot #

NFData CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

rnf :: CreateSnapshot -> () #

Hashable CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

hashWithSalt :: Int -> CreateSnapshot -> Int #

hash :: CreateSnapshot -> Int #

AWSRequest CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Associated Types

type AWSResponse CreateSnapshot #

Methods

request :: CreateSnapshot -> Request CreateSnapshot #

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

ToHeaders CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

toHeaders :: CreateSnapshot -> [Header] #

ToPath CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

toPath :: CreateSnapshot -> ByteString #

ToQuery CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

toQuery :: CreateSnapshot -> QueryString #

type Rep CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

type Rep CreateSnapshot = D1 ('MetaData "CreateSnapshot" "Amazonka.ElastiCache.CreateSnapshot" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "CreateSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cacheClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateSnapshot Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

type AWSResponse CreateSnapshot = CreateSnapshotResponse

newCreateSnapshot Source #

Arguments

:: Text

$sel:snapshotName:CreateSnapshot'

-> CreateSnapshot 

Create a value of CreateSnapshot 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:cacheClusterId:CreateSnapshot', createSnapshot_cacheClusterId - The identifier of an existing cluster. The snapshot is created from this cluster.

$sel:kmsKeyId:CreateSnapshot', createSnapshot_kmsKeyId - The ID of the KMS key used to encrypt the snapshot.

$sel:replicationGroupId:CreateSnapshot', createSnapshot_replicationGroupId - The identifier of an existing replication group. The snapshot is created from this replication group.

$sel:tags:CreateSnapshot', createSnapshot_tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

$sel:snapshotName:CreateSnapshot', createSnapshot_snapshotName - A name for the snapshot being created.

Request Lenses

createSnapshot_cacheClusterId :: Lens' CreateSnapshot (Maybe Text) Source #

The identifier of an existing cluster. The snapshot is created from this cluster.

createSnapshot_kmsKeyId :: Lens' CreateSnapshot (Maybe Text) Source #

The ID of the KMS key used to encrypt the snapshot.

createSnapshot_replicationGroupId :: Lens' CreateSnapshot (Maybe Text) Source #

The identifier of an existing replication group. The snapshot is created from this replication group.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createSnapshot_snapshotName :: Lens' CreateSnapshot Text Source #

A name for the snapshot being created.

Destructuring the Response

data CreateSnapshotResponse Source #

See: newCreateSnapshotResponse smart constructor.

Constructors

CreateSnapshotResponse' 

Fields

Instances

Instances details
Eq CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

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

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

Read CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

readsPrec :: Int -> ReadS CreateSnapshotResponse #

readList :: ReadS [CreateSnapshotResponse] #

readPrec :: ReadPrec CreateSnapshotResponse #

readListPrec :: ReadPrec [CreateSnapshotResponse] #

Show CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

showsPrec :: Int -> CreateSnapshotResponse -> ShowS #

show :: CreateSnapshotResponse -> String #

showList :: [CreateSnapshotResponse] -> ShowS #

Generic CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Associated Types

type Rep CreateSnapshotResponse :: Type -> Type #

Methods

from :: CreateSnapshotResponse -> Rep CreateSnapshotResponse x #

to :: Rep CreateSnapshotResponse x -> CreateSnapshotResponse #

NFData CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

Methods

rnf :: CreateSnapshotResponse -> () #

type Rep CreateSnapshotResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.CreateSnapshot

type Rep CreateSnapshotResponse = D1 ('MetaData "CreateSnapshotResponse" "Amazonka.ElastiCache.CreateSnapshot" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "CreateSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Snapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSnapshotResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateSnapshotResponse'

-> CreateSnapshotResponse 

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

$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int Source #

The response's http status code.