« blib/lib/Paws/EC2/ImportClientVpnClientCertificateRevocationListResult.pm
↑ Summary
blib/lib/Paws/EC2/ImportImageLicenseConfigurationRequest.pm »
| 1 | |||
| 2 | package Paws::EC2::ImportImage; | ||
| 3 | use Moose; | ||
| 4 | has Architecture => (is => 'ro', isa => 'Str'); | ||
| 5 | has ClientData => (is => 'ro', isa => 'Paws::EC2::ClientData'); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has DiskContainers => (is => 'ro', isa => 'ArrayRef[Paws::EC2::ImageDiskContainer]', traits => ['NameInRequest'], request_name => 'DiskContainer' ); | ||
| 9 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 10 | has Encrypted => (is => 'ro', isa => 'Bool'); | ||
| 11 | has Hypervisor => (is => 'ro', isa => 'Str'); | ||
| 12 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 13 | has LicenseSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::ImportImageLicenseConfigurationRequest]'); | ||
| 14 | has LicenseType => (is => 'ro', isa => 'Str'); | ||
| 15 | has Platform => (is => 'ro', isa => 'Str'); | ||
| 16 | has RoleName => (is => 'ro', isa => 'Str'); | ||
| 17 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 18 | |||
| 19 | use MooseX::ClassAttribute; | ||
| 20 | |||
| 21 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportImage'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ImportImageResult'); | ||
| 23 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::EC2::ImportImage - Arguments for method ImportImage on L<Paws::EC2> | ||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This class represents the parameters used for calling the method ImportImage on the | ||
| 35 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 36 | as arguments to method ImportImage. | ||
| 37 | |||
| 38 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportImage. | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | my $ec2 = Paws->service('EC2'); | ||
| 43 | my $ImportImageResult = $ec2->ImportImage( | ||
| 44 | Architecture => 'MyString', # OPTIONAL | ||
| 45 | ClientData => { | ||
| 46 | Comment => 'MyString', | ||
| 47 | UploadEnd => '1970-01-01T01:00:00', # OPTIONAL | ||
| 48 | UploadSize => 1, # OPTIONAL | ||
| 49 | UploadStart => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | ClientToken => 'MyString', # OPTIONAL | ||
| 52 | Description => 'MyString', # OPTIONAL | ||
| 53 | DiskContainers => [ | ||
| 54 | { | ||
| 55 | Description => 'MyString', | ||
| 56 | DeviceName => 'MyString', | ||
| 57 | Format => 'MyString', | ||
| 58 | SnapshotId => 'MySnapshotId', # OPTIONAL | ||
| 59 | Url => 'MyString', | ||
| 60 | UserBucket => { | ||
| 61 | S3Bucket => 'MyString', | ||
| 62 | S3Key => 'MyString', | ||
| 63 | }, # OPTIONAL | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | DryRun => 1, # OPTIONAL | ||
| 68 | Encrypted => 1, # OPTIONAL | ||
| 69 | Hypervisor => 'MyString', # OPTIONAL | ||
| 70 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 71 | LicenseSpecifications => | ||
| 72 | [ { LicenseConfigurationArn => 'MyString', }, ... ], # OPTIONAL | ||
| 73 | LicenseType => 'MyString', # OPTIONAL | ||
| 74 | Platform => 'MyString', # OPTIONAL | ||
| 75 | RoleName => 'MyString', # OPTIONAL | ||
| 76 | TagSpecifications => [ | ||
| 77 | { | ||
| 78 | ResourceType => 'client-vpn-endpoint' | ||
| 79 | , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL | ||
| 80 | Tags => [ | ||
| 81 | { | ||
| 82 | Key => 'MyString', | ||
| 83 | Value => 'MyString', | ||
| 84 | }, | ||
| 85 | ... | ||
| 86 | ], # OPTIONAL | ||
| 87 | }, | ||
| 88 | ... | ||
| 89 | ], # OPTIONAL | ||
| 90 | ); | ||
| 91 | |||
| 92 | # Results: | ||
| 93 | my $Architecture = $ImportImageResult->Architecture; | ||
| 94 | my $Description = $ImportImageResult->Description; | ||
| 95 | my $Encrypted = $ImportImageResult->Encrypted; | ||
| 96 | my $Hypervisor = $ImportImageResult->Hypervisor; | ||
| 97 | my $ImageId = $ImportImageResult->ImageId; | ||
| 98 | my $ImportTaskId = $ImportImageResult->ImportTaskId; | ||
| 99 | my $KmsKeyId = $ImportImageResult->KmsKeyId; | ||
| 100 | my $LicenseSpecifications = $ImportImageResult->LicenseSpecifications; | ||
| 101 | my $LicenseType = $ImportImageResult->LicenseType; | ||
| 102 | my $Platform = $ImportImageResult->Platform; | ||
| 103 | my $Progress = $ImportImageResult->Progress; | ||
| 104 | my $SnapshotDetails = $ImportImageResult->SnapshotDetails; | ||
| 105 | my $Status = $ImportImageResult->Status; | ||
| 106 | my $StatusMessage = $ImportImageResult->StatusMessage; | ||
| 107 | my $Tags = $ImportImageResult->Tags; | ||
| 108 | |||
| 109 | # Returns a L<Paws::EC2::ImportImageResult> object. | ||
| 110 | |||
| 111 | 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. | ||
| 112 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ImportImage> | ||
| 113 | |||
| 114 | =head1 ATTRIBUTES | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Architecture => Str | ||
| 118 | |||
| 119 | The architecture of the virtual machine. | ||
| 120 | |||
| 121 | Valid values: C<i386> | C<x86_64> | C<arm64> | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 ClientData => L<Paws::EC2::ClientData> | ||
| 126 | |||
| 127 | The client-specific data. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 ClientToken => Str | ||
| 132 | |||
| 133 | The token to enable idempotency for VM import requests. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 Description => Str | ||
| 138 | |||
| 139 | A description string for the import image task. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 DiskContainers => ArrayRef[L<Paws::EC2::ImageDiskContainer>] | ||
| 144 | |||
| 145 | Information about the disk containers. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 DryRun => Bool | ||
| 150 | |||
| 151 | Checks whether you have the required permissions for the action, | ||
| 152 | without actually making the request, and provides an error response. If | ||
| 153 | you have the required permissions, the error response is | ||
| 154 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 Encrypted => Bool | ||
| 159 | |||
| 160 | Specifies whether the destination AMI of the imported image should be | ||
| 161 | encrypted. The default CMK for EBS is used unless you specify a | ||
| 162 | non-default AWS Key Management Service (AWS KMS) CMK using C<KmsKeyId>. | ||
| 163 | For more information, see Amazon EBS Encryption | ||
| 164 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) | ||
| 165 | in the I<Amazon Elastic Compute Cloud User Guide>. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 Hypervisor => Str | ||
| 170 | |||
| 171 | The target hypervisor platform. | ||
| 172 | |||
| 173 | Valid values: C<xen> | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 KmsKeyId => Str | ||
| 178 | |||
| 179 | An identifier for the symmetric AWS Key Management Service (AWS KMS) | ||
| 180 | customer master key (CMK) to use when creating the encrypted AMI. This | ||
| 181 | parameter is only required if you want to use a non-default CMK; if | ||
| 182 | this parameter is not specified, the default CMK for EBS is used. If a | ||
| 183 | C<KmsKeyId> is specified, the C<Encrypted> flag must also be set. | ||
| 184 | |||
| 185 | The CMK identifier may be provided in any of the following formats: | ||
| 186 | |||
| 187 | =over | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | Key ID | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | Key alias. The alias ARN contains the C<arn:aws:kms> namespace, | ||
| 196 | followed by the Region of the CMK, the AWS account ID of the CMK owner, | ||
| 197 | the C<alias> namespace, and then the CMK alias. For example, | ||
| 198 | arn:aws:kms:I<us-east-1>:I<012345678910>:alias/I<ExampleAlias>. | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | ARN using key ID. The ID ARN contains the C<arn:aws:kms> namespace, | ||
| 203 | followed by the Region of the CMK, the AWS account ID of the CMK owner, | ||
| 204 | the C<key> namespace, and then the CMK ID. For example, | ||
| 205 | arn:aws:kms:I<us-east-1>:I<012345678910>:key/I<abcd1234-a123-456a-a12b-a123b4cd56ef>. | ||
| 206 | |||
| 207 | =item * | ||
| 208 | |||
| 209 | ARN using key alias. The alias ARN contains the C<arn:aws:kms> | ||
| 210 | namespace, followed by the Region of the CMK, the AWS account ID of the | ||
| 211 | CMK owner, the C<alias> namespace, and then the CMK alias. For example, | ||
| 212 | arn:aws:kms:I<us-east-1>:I<012345678910>:alias/I<ExampleAlias>. | ||
| 213 | |||
| 214 | =back | ||
| 215 | |||
| 216 | AWS parses C<KmsKeyId> asynchronously, meaning that the action you call | ||
| 217 | may appear to complete even though you provided an invalid identifier. | ||
| 218 | This action will eventually report failure. | ||
| 219 | |||
| 220 | The specified CMK must exist in the Region that the AMI is being copied | ||
| 221 | to. | ||
| 222 | |||
| 223 | Amazon EBS does not support asymmetric CMKs. | ||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head2 LicenseSpecifications => ArrayRef[L<Paws::EC2::ImportImageLicenseConfigurationRequest>] | ||
| 228 | |||
| 229 | The ARNs of the license configurations. | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head2 LicenseType => Str | ||
| 234 | |||
| 235 | The license type to be used for the Amazon Machine Image (AMI) after | ||
| 236 | importing. | ||
| 237 | |||
| 238 | By default, we detect the source-system operating system (OS) and apply | ||
| 239 | the appropriate license. Specify C<AWS> to replace the source-system | ||
| 240 | license with an AWS license, if appropriate. Specify C<BYOL> to retain | ||
| 241 | the source-system license, if appropriate. | ||
| 242 | |||
| 243 | To use C<BYOL>, you must have existing licenses with rights to use | ||
| 244 | these licenses in a third party cloud, such as AWS. For more | ||
| 245 | information, see Prerequisites | ||
| 246 | (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image) | ||
| 247 | in the VM Import/Export User Guide. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 Platform => Str | ||
| 252 | |||
| 253 | The operating system of the virtual machine. | ||
| 254 | |||
| 255 | Valid values: C<Windows> | C<Linux> | ||
| 256 | |||
| 257 | |||
| 258 | |||
| 259 | =head2 RoleName => Str | ||
| 260 | |||
| 261 | The name of the role to use when not using the default role, | ||
| 262 | 'vmimport'. | ||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 267 | |||
| 268 | The tags to apply to the import image task during creation. | ||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | |||
| 273 | =head1 SEE ALSO | ||
| 274 | |||
| 275 | This class forms part of L<Paws>, documenting arguments for method ImportImage in L<Paws::EC2> | ||
| 276 | |||
| 277 | =head1 BUGS and CONTRIBUTIONS | ||
| 278 | |||
| 279 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 280 | |||
| 281 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 282 | |||
| 283 | =cut | ||
| 284 |