ImportSnapshotRequest
¶
Source code in docs_src/capo_ec2/types/import_snapshot_request.py
client_token
instance-attribute
¶
client_token: NotRequired[String]
Token to enable idempotency for VM import requests.
description
instance-attribute
¶
description: NotRequired[String]
The description string for the import snapshot task.
disk_container
instance-attribute
¶
disk_container: NotRequired[SnapshotDiskContainer]
Information about the disk container.
dry_run
instance-attribute
¶
dry_run: NotRequired[Boolean]
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.
encrypted
instance-attribute
¶
encrypted: NotRequired[Boolean]
Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[KmsKeyId]
An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kmsnamespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekeynamespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. -
ARN using key alias. The alias ARN contains the
arn:aws:kmsnamespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thealiasnamespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
role_name
instance-attribute
¶
role_name: NotRequired[String]
The name of the role to use when not using the default role, 'vmimport'.
tag_specifications
instance-attribute
¶
tag_specifications: NotRequired[TagSpecificationList]
The tags to apply to the import snapshot task during creation.