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.EC2.CreateSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.

You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

Synopsis

data CreateSnapshots = CreateSnapshots' {
- copyTagsFromSource :: Maybe CopyTagsFromSource
- description :: Maybe Text
- dryRun :: Maybe Bool
- outpostArn :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- instanceSpecification :: InstanceSpecification
}
newCreateSnapshots :: InstanceSpecification -> CreateSnapshots
createSnapshots_copyTagsFromSource :: Lens' CreateSnapshots (Maybe CopyTagsFromSource)
createSnapshots_description :: Lens' CreateSnapshots (Maybe Text)
createSnapshots_dryRun :: Lens' CreateSnapshots (Maybe Bool)
createSnapshots_outpostArn :: Lens' CreateSnapshots (Maybe Text)
createSnapshots_tagSpecifications :: Lens' CreateSnapshots (Maybe [TagSpecification])
createSnapshots_instanceSpecification :: Lens' CreateSnapshots InstanceSpecification
data CreateSnapshotsResponse = CreateSnapshotsResponse' {
- snapshots :: Maybe [SnapshotInfo]
- httpStatus :: Int
}
newCreateSnapshotsResponse :: Int -> CreateSnapshotsResponse
createSnapshotsResponse_snapshots :: Lens' CreateSnapshotsResponse (Maybe [SnapshotInfo])
createSnapshotsResponse_httpStatus :: Lens' CreateSnapshotsResponse Int

Creating a Request

data CreateSnapshots Source #

See: newCreateSnapshots smart constructor.

Constructors

CreateSnapshots'

Fields

copyTagsFromSource :: Maybe CopyTagsFromSource
Copies the tags from the specified volume to corresponding snapshot.
description :: Maybe Text
A description propagated to every snapshot specified by the instance.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
outpostArn :: Maybe Text
The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
- To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
- To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
- To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
tagSpecifications :: Maybe [TagSpecification]
Tags to apply to every snapshot specified by the instance.
instanceSpecification :: InstanceSpecification
The instance to specify which volumes should be included in the snapshots.

Instances

Instances details

ToHeaders CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods toHeaders :: CreateSnapshots -> [Header] #
ToPath CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods toPath :: CreateSnapshots -> ByteString #
ToQuery CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods toQuery :: CreateSnapshots -> QueryString #
AWSRequest CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Associated Types type AWSResponse CreateSnapshots # Methods request :: (Service -> Service) -> CreateSnapshots -> Request CreateSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSnapshots))) #
Generic CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Associated Types type Rep CreateSnapshots :: Type -> Type # Methods from :: CreateSnapshots -> Rep CreateSnapshots x # to :: Rep CreateSnapshots x -> CreateSnapshots #
Read CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods readsPrec :: Int -> ReadS CreateSnapshots # readList :: ReadS [CreateSnapshots] # readPrec :: ReadPrec CreateSnapshots # readListPrec :: ReadPrec [CreateSnapshots] #
Show CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods showsPrec :: Int -> CreateSnapshots -> ShowS # show :: CreateSnapshots -> String # showList :: [CreateSnapshots] -> ShowS #
NFData CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods rnf :: CreateSnapshots -> () #
Eq CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods (==) :: CreateSnapshots -> CreateSnapshots -> Bool # (/=) :: CreateSnapshots -> CreateSnapshots -> Bool #
Hashable CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots Methods hashWithSalt :: Int -> CreateSnapshots -> Int # hash :: CreateSnapshots -> Int #
type AWSResponse CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots type AWSResponse CreateSnapshots = CreateSnapshotsResponse
type Rep CreateSnapshots Source #
Instance details Defined in Amazonka.EC2.CreateSnapshots type Rep CreateSnapshots = D1 ('MetaData "CreateSnapshots" "Amazonka.EC2.CreateSnapshots" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyTagsFromSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyTagsFromSource)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "outpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :*: S1 ('MetaSel ('Just "instanceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InstanceSpecification)))))

newCreateSnapshots Source #

Arguments

:: InstanceSpecification	`$sel:instanceSpecification:CreateSnapshots'`
-> CreateSnapshots

Create a value of CreateSnapshots 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:copyTagsFromSource:CreateSnapshots', createSnapshots_copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.

CreateSnapshots, createSnapshots_description - A description propagated to every snapshot specified by the instance.

$sel:dryRun:CreateSnapshots', createSnapshots_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

CreateSnapshots, createSnapshots_outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

CreateSnapshots, createSnapshots_tagSpecifications - Tags to apply to every snapshot specified by the instance.

$sel:instanceSpecification:CreateSnapshots', createSnapshots_instanceSpecification - The instance to specify which volumes should be included in the snapshots.

Request Lenses

createSnapshots_copyTagsFromSource :: Lens' CreateSnapshots (Maybe CopyTagsFromSource) Source #

Copies the tags from the specified volume to corresponding snapshot.

createSnapshots_description :: Lens' CreateSnapshots (Maybe Text) Source #

A description propagated to every snapshot specified by the instance.

createSnapshots_dryRun :: Lens' CreateSnapshots (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

createSnapshots_outpostArn :: Lens' CreateSnapshots (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

createSnapshots_tagSpecifications :: Lens' CreateSnapshots (Maybe [TagSpecification]) Source #

Tags to apply to every snapshot specified by the instance.

createSnapshots_instanceSpecification :: Lens' CreateSnapshots InstanceSpecification Source #

The instance to specify which volumes should be included in the snapshots.

Destructuring the Response

data CreateSnapshotsResponse Source #

See: newCreateSnapshotsResponse smart constructor.

Constructors

CreateSnapshotsResponse'
Fields snapshots :: Maybe [SnapshotInfo] List of snapshots. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateSnapshotsResponse Source #

Arguments

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

Create a value of CreateSnapshotsResponse 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:snapshots:CreateSnapshotsResponse', createSnapshotsResponse_snapshots - List of snapshots.

$sel:httpStatus:CreateSnapshotsResponse', createSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

createSnapshotsResponse_snapshots :: Lens' CreateSnapshotsResponse (Maybe [SnapshotInfo]) Source #

List of snapshots.

createSnapshotsResponse_httpStatus :: Lens' CreateSnapshotsResponse Int Source #

The response's http status code.