/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::EBS::StartSnapshot

NAME

Paws::EBS::StartSnapshot - Arguments for method StartSnapshot on Paws::EBS

DESCRIPTION

This class represents the parameters used for calling the method StartSnapshot on the Amazon Elastic Block Store service. Use the attributes of this class as arguments to method StartSnapshot.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSnapshot.

SYNOPSIS

my $ebs = Paws->service('EBS');
my $StartSnapshotResponse = $ebs->StartSnapshot(
  VolumeSize       => 1,
  ClientToken      => 'MyIdempotencyToken',    # OPTIONAL
  Description      => 'MyDescription',         # OPTIONAL
  Encrypted        => 1,                       # OPTIONAL
  KmsKeyArn        => 'MyKmsKeyArn',           # OPTIONAL
  ParentSnapshotId => 'MySnapshotId',          # OPTIONAL
  Tags             => [
    {
      Key   => 'MyTagKey',      # max: 127; OPTIONAL
      Value => 'MyTagValue',    # max: 255; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  Timeout => 1,    # OPTIONAL
);

# Results:
my $BlockSize        = $StartSnapshotResponse->BlockSize;
my $Description      = $StartSnapshotResponse->Description;
my $KmsKeyArn        = $StartSnapshotResponse->KmsKeyArn;
my $OwnerId          = $StartSnapshotResponse->OwnerId;
my $ParentSnapshotId = $StartSnapshotResponse->ParentSnapshotId;
my $SnapshotId       = $StartSnapshotResponse->SnapshotId;
my $StartTime        = $StartSnapshotResponse->StartTime;
my $Status           = $StartSnapshotResponse->Status;
my $Tags             = $StartSnapshotResponse->Tags;
my $VolumeSize       = $StartSnapshotResponse->VolumeSize;

# Returns a L<Paws::EBS::StartSnapshotResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ebs/StartSnapshot

ATTRIBUTES

ClientToken => Str

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html) in the Amazon Elastic Compute Cloud User Guide.

Description => Str

A description for the snapshot.

Encrypted => Bool

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html).

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption) in the Amazon Elastic Compute Cloud User Guide.

KmsKeyArn => Str

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

ParentSnapshotId => Str

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html).

Tags => ArrayRef[Paws::EBS::Tag]

The tags to apply to the snapshot.

Timeout => Int

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

REQUIRED VolumeSize => Int

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

SEE ALSO

This class forms part of Paws, documenting arguments for method StartSnapshot in Paws::EBS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues