/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** *

Contains the parameters for RegisterImage.

*/ class RegisterImageRequest : public EC2Request { public: AWS_EC2_API RegisterImageRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "RegisterImage"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The full path to your AMI manifest in Amazon S3 storage. The specified bucket * must have the aws-exec-read canned access control list (ACL) to * ensure that it can be accessed by Amazon EC2. For more information, see Canned * ACLs in the Amazon S3 Service Developer Guide.

*/ inline const Aws::String& GetImageLocation() const{ return m_imageLocation; } /** *

*/ inline bool ImageLocationHasBeenSet() const { return m_imageLocationHasBeenSet; } /** *

*/ inline void SetImageLocation(const Aws::String& value) { m_imageLocationHasBeenSet = true; m_imageLocation = value; } /** *

*/ inline void SetImageLocation(Aws::String&& value) { m_imageLocationHasBeenSet = true; m_imageLocation = std::move(value); } /** *

*/ inline void SetImageLocation(const char* value) { m_imageLocationHasBeenSet = true; m_imageLocation.assign(value); } /** *

*/ inline RegisterImageRequest& WithImageLocation(const Aws::String& value) { SetImageLocation(value); return *this;} /** *

*/ inline RegisterImageRequest& WithImageLocation(Aws::String&& value) { SetImageLocation(std::move(value)); return *this;} /** *

*/ inline RegisterImageRequest& WithImageLocation(const char* value) { SetImageLocation(value); return *this;} /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline const ArchitectureValues& GetArchitecture() const{ return m_architecture; } /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline bool ArchitectureHasBeenSet() const { return m_architectureHasBeenSet; } /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline void SetArchitecture(const ArchitectureValues& value) { m_architectureHasBeenSet = true; m_architecture = value; } /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline void SetArchitecture(ArchitectureValues&& value) { m_architectureHasBeenSet = true; m_architecture = std::move(value); } /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline RegisterImageRequest& WithArchitecture(const ArchitectureValues& value) { SetArchitecture(value); return *this;} /** *

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, * i386. For instance store-backed AMIs, the architecture specified in * the manifest file.

*/ inline RegisterImageRequest& WithArchitecture(ArchitectureValues&& value) { SetArchitecture(std::move(value)); return *this;} /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

If you create an AMI on an Outpost, then all backing * snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on * an Outpost that include local snapshots can be used to launch instances on the * same Outpost only. For more information, Amazon * EBS local snapshots on Outposts in the Amazon EC2 User Guide.

*/ inline const Aws::Vector& GetBlockDeviceMappings() const{ return m_blockDeviceMappings; } /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline bool BlockDeviceMappingsHasBeenSet() const { return m_blockDeviceMappingsHasBeenSet; } /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline void SetBlockDeviceMappings(const Aws::Vector& value) { m_blockDeviceMappingsHasBeenSet = true; m_blockDeviceMappings = value; } /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline void SetBlockDeviceMappings(Aws::Vector&& value) { m_blockDeviceMappingsHasBeenSet = true; m_blockDeviceMappings = std::move(value); } /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline RegisterImageRequest& WithBlockDeviceMappings(const Aws::Vector& value) { SetBlockDeviceMappings(value); return *this;} /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline RegisterImageRequest& WithBlockDeviceMappings(Aws::Vector&& value) { SetBlockDeviceMappings(std::move(value)); return *this;} /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline RegisterImageRequest& AddBlockDeviceMappings(const BlockDeviceMapping& value) { m_blockDeviceMappingsHasBeenSet = true; m_blockDeviceMappings.push_back(value); return *this; } /** *

The block device mapping entries.

If you specify an Amazon EBS volume * using the ID of an Amazon EBS snapshot, you can't specify the encryption state * of the volume.

*/ inline RegisterImageRequest& AddBlockDeviceMappings(BlockDeviceMapping&& value) { m_blockDeviceMappingsHasBeenSet = true; m_blockDeviceMappings.push_back(std::move(value)); return *this; } /** *

A description for your AMI.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description for your AMI.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description for your AMI.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description for your AMI.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description for your AMI.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description for your AMI.

*/ inline RegisterImageRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description for your AMI.

*/ inline RegisterImageRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description for your AMI.

*/ inline RegisterImageRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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.

*/ inline bool GetDryRun() const{ return m_dryRun; } /** *

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

*/ inline RegisterImageRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

Set to true to enable enhanced networking with ENA for the AMI * and any instances that you launch from the AMI.

This option is supported * only for HVM AMIs. Specifying this option with a PV AMI can make instances * launched from the AMI unreachable.

*/ inline bool GetEnaSupport() const{ return m_enaSupport; } /** *

Set to true to enable enhanced networking with ENA for the AMI * and any instances that you launch from the AMI.

This option is supported * only for HVM AMIs. Specifying this option with a PV AMI can make instances * launched from the AMI unreachable.

*/ inline bool EnaSupportHasBeenSet() const { return m_enaSupportHasBeenSet; } /** *

Set to true to enable enhanced networking with ENA for the AMI * and any instances that you launch from the AMI.

This option is supported * only for HVM AMIs. Specifying this option with a PV AMI can make instances * launched from the AMI unreachable.

*/ inline void SetEnaSupport(bool value) { m_enaSupportHasBeenSet = true; m_enaSupport = value; } /** *

Set to true to enable enhanced networking with ENA for the AMI * and any instances that you launch from the AMI.

This option is supported * only for HVM AMIs. Specifying this option with a PV AMI can make instances * launched from the AMI unreachable.

*/ inline RegisterImageRequest& WithEnaSupport(bool value) { SetEnaSupport(value); return *this;} /** *

The ID of the kernel.

*/ inline const Aws::String& GetKernelId() const{ return m_kernelId; } /** *

The ID of the kernel.

*/ inline bool KernelIdHasBeenSet() const { return m_kernelIdHasBeenSet; } /** *

The ID of the kernel.

*/ inline void SetKernelId(const Aws::String& value) { m_kernelIdHasBeenSet = true; m_kernelId = value; } /** *

The ID of the kernel.

*/ inline void SetKernelId(Aws::String&& value) { m_kernelIdHasBeenSet = true; m_kernelId = std::move(value); } /** *

The ID of the kernel.

*/ inline void SetKernelId(const char* value) { m_kernelIdHasBeenSet = true; m_kernelId.assign(value); } /** *

The ID of the kernel.

*/ inline RegisterImageRequest& WithKernelId(const Aws::String& value) { SetKernelId(value); return *this;} /** *

The ID of the kernel.

*/ inline RegisterImageRequest& WithKernelId(Aws::String&& value) { SetKernelId(std::move(value)); return *this;} /** *

The ID of the kernel.

*/ inline RegisterImageRequest& WithKernelId(const char* value) { SetKernelId(value); return *this;} /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline RegisterImageRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline RegisterImageRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

A name for your AMI.

Constraints: 3-128 alphanumeric characters, * parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), * dashes (-), single quotes ('), at-signs (@), or underscores(_)

*/ inline RegisterImageRequest& WithName(const char* value) { SetName(value); return *this;} /** *