/** * 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 namespace Aws { namespace EC2 { namespace Model { /** */ class AWS_EC2_API CreateVolumeRequest : public EC2Request { public: CreateVolumeRequest(); // 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 "CreateVolume"; } Aws::String SerializePayload() const override; protected: void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The Availability Zone in which to create the volume.

*/ inline const Aws::String& GetAvailabilityZone() const{ return m_availabilityZone; } /** *

The Availability Zone in which to create the volume.

*/ inline bool AvailabilityZoneHasBeenSet() const { return m_availabilityZoneHasBeenSet; } /** *

The Availability Zone in which to create the volume.

*/ inline void SetAvailabilityZone(const Aws::String& value) { m_availabilityZoneHasBeenSet = true; m_availabilityZone = value; } /** *

The Availability Zone in which to create the volume.

*/ inline void SetAvailabilityZone(Aws::String&& value) { m_availabilityZoneHasBeenSet = true; m_availabilityZone = std::move(value); } /** *

The Availability Zone in which to create the volume.

*/ inline void SetAvailabilityZone(const char* value) { m_availabilityZoneHasBeenSet = true; m_availabilityZone.assign(value); } /** *

The Availability Zone in which to create the volume.

*/ inline CreateVolumeRequest& WithAvailabilityZone(const Aws::String& value) { SetAvailabilityZone(value); return *this;} /** *

The Availability Zone in which to create the volume.

*/ inline CreateVolumeRequest& WithAvailabilityZone(Aws::String&& value) { SetAvailabilityZone(std::move(value)); return *this;} /** *

The Availability Zone in which to create the volume.

*/ inline CreateVolumeRequest& WithAvailabilityZone(const char* value) { SetAvailabilityZone(value); return *this;} /** *

Specifies whether the volume should be encrypted. The effect of setting the * encryption state to true depends on the volume origin (new or from * a snapshot), starting encryption state, ownership, and whether encryption by * default is enabled. For more information, see Encryption * by default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support * Amazon EBS encryption. For more information, see Supported * instance types.

*/ inline bool GetEncrypted() const{ return m_encrypted; } /** *

Encrypted Amazon EBS volumes must be attached to instances that support * Amazon EBS encryption. For more information, see Supported * instance types.

*/ inline bool EncryptedHasBeenSet() const { return m_encryptedHasBeenSet; } /** *

Encrypted Amazon EBS volumes must be attached to instances that support * Amazon EBS encryption. For more information, see Supported * instance types.

*/ inline void SetEncrypted(bool value) { m_encryptedHasBeenSet = true; m_encrypted = value; } /** *

Encrypted Amazon EBS volumes must be attached to instances that support * Amazon EBS encryption. For more information, see Supported * instance types.

*/ inline CreateVolumeRequest& WithEncrypted(bool value) { SetEncrypted(value); return *this;} /** *

The number of I/O operations per second (IOPS) to provision for an * io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB * for io1, and 500 IOPS/GiB for io2. Range is 100 to * 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed * only on Nitro-based * instances. Other instance families guarantee performance up to 32,000 IOPS. * For more information, see Amazon * EBS volume types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1 and * io2) volumes.

*/ inline int GetIops() const{ return m_iops; } /** *

This parameter is valid only for Provisioned IOPS SSD (io1 and * io2) volumes.

*/ inline bool IopsHasBeenSet() const { return m_iopsHasBeenSet; } /** *

This parameter is valid only for Provisioned IOPS SSD (io1 and * io2) volumes.

*/ inline void SetIops(int value) { m_iopsHasBeenSet = true; m_iops = value; } /** *

This parameter is valid only for Provisioned IOPS SSD (io1 and * io2) volumes.

*/ inline CreateVolumeRequest& WithIops(int value) { SetIops(value); return *this;} /** *

The identifier of the AWS Key Management Service (AWS KMS) customer master * key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, * your AWS managed CMK for EBS is used. If KmsKeyId is specified, the * encrypted state must be true.

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline CreateVolumeRequest& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline CreateVolumeRequest& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

You can specify the CMK using * any of the following:

Key ID. For example, * key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For * example, alias/ExampleAlias.
Key ARN. For example, * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
Alias ARN. For example, * arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*

AWS authenticates the CMK asynchronously. Therefore, if you * specify an ID, alias, or ARN that is not valid, the action can appear to * complete, but eventually fails.

*/ inline CreateVolumeRequest& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline const Aws::String& GetOutpostArn() const{ return m_outpostArn; } /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline bool OutpostArnHasBeenSet() const { return m_outpostArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline void SetOutpostArn(const Aws::String& value) { m_outpostArnHasBeenSet = true; m_outpostArn = value; } /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline void SetOutpostArn(Aws::String&& value) { m_outpostArnHasBeenSet = true; m_outpostArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline void SetOutpostArn(const char* value) { m_outpostArnHasBeenSet = true; m_outpostArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline CreateVolumeRequest& WithOutpostArn(const Aws::String& value) { SetOutpostArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline CreateVolumeRequest& WithOutpostArn(Aws::String&& value) { SetOutpostArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ inline CreateVolumeRequest& WithOutpostArn(const char* value) { SetOutpostArn(value); return *this;} /** *

The size of the volume, in GiBs. You must specify either a snapshot ID or a * volume size.

Constraints: 1-16,384 for gp2, 4-16,384 for * io1 and io2, 500-16,384 for st1, * 500-16,384 for sc1, and 1-1,024 for standard. If you * specify a snapshot, the volume size must be equal to or larger than the snapshot * size.

Default: If you're creating the volume from a snapshot and don't * specify a volume size, the default is the snapshot size.

*/ inline int GetSize() const{ return m_size; } /** *

The size of the volume, in GiBs. You must specify either a snapshot ID or a * volume size.

Default: If you're creating the volume from a snapshot and don't * specify a volume size, the default is the snapshot size.

*/ inline bool SizeHasBeenSet() const { return m_sizeHasBeenSet; } /** *

The size of the volume, in GiBs. You must specify either a snapshot ID or a * volume size.

Default: If you're creating the volume from a snapshot and don't * specify a volume size, the default is the snapshot size.

*/ inline void SetSize(int value) { m_sizeHasBeenSet = true; m_size = value; } /** *

The size of the volume, in GiBs. You must specify either a snapshot ID or a * volume size.

Default: If you're creating the volume from a snapshot and don't * specify a volume size, the default is the snapshot size.

*/ inline CreateVolumeRequest& WithSize(int value) { SetSize(value); return *this;} /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline const Aws::String& GetSnapshotId() const{ return m_snapshotId; } /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline bool SnapshotIdHasBeenSet() const { return m_snapshotIdHasBeenSet; } /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline void SetSnapshotId(const Aws::String& value) { m_snapshotIdHasBeenSet = true; m_snapshotId = value; } /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline void SetSnapshotId(Aws::String&& value) { m_snapshotIdHasBeenSet = true; m_snapshotId = std::move(value); } /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline void SetSnapshotId(const char* value) { m_snapshotIdHasBeenSet = true; m_snapshotId.assign(value); } /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline CreateVolumeRequest& WithSnapshotId(const Aws::String& value) { SetSnapshotId(value); return *this;} /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline CreateVolumeRequest& WithSnapshotId(Aws::String&& value) { SetSnapshotId(std::move(value)); return *this;} /** *

The snapshot from which to create the volume. You must specify either a * snapshot ID or a volume size.

*/ inline CreateVolumeRequest& WithSnapshotId(const char* value) { SetSnapshotId(value); return *this;} /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline const VolumeType& GetVolumeType() const{ return m_volumeType; } /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline bool VolumeTypeHasBeenSet() const { return m_volumeTypeHasBeenSet; } /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline void SetVolumeType(const VolumeType& value) { m_volumeTypeHasBeenSet = true; m_volumeType = value; } /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline void SetVolumeType(VolumeType&& value) { m_volumeTypeHasBeenSet = true; m_volumeType = std::move(value); } /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline CreateVolumeRequest& WithVolumeType(const VolumeType& value) { SetVolumeType(value); return *this;} /** *

The volume type. This can be gp2 for General Purpose SSD, * io1 or io2 for Provisioned IOPS SSD, st1 * for Throughput Optimized HDD, sc1 for Cold HDD, or * standard for Magnetic volumes.

Default: gp2 *

*/ inline CreateVolumeRequest& WithVolumeType(VolumeType&& value) { SetVolumeType(std::move(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 CreateVolumeRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The tags to apply to the volume during creation.

*/ inline const Aws::Vector& GetTagSpecifications() const{ return m_tagSpecifications; } /** *

The tags to apply to the volume during creation.

*/ inline bool TagSpecificationsHasBeenSet() const { return m_tagSpecificationsHasBeenSet; } /** *

The tags to apply to the volume during creation.

*/ inline void SetTagSpecifications(const Aws::Vector& value) { m_tagSpecificationsHasBeenSet = true; m_tagSpecifications = value; } /** *

The tags to apply to the volume during creation.

*/ inline void SetTagSpecifications(Aws::Vector&& value) { m_tagSpecificationsHasBeenSet = true; m_tagSpecifications = std::move(value); } /** *

The tags to apply to the volume during creation.

*/ inline CreateVolumeRequest& WithTagSpecifications(const Aws::Vector& value) { SetTagSpecifications(value); return *this;} /** *

The tags to apply to the volume during creation.

*/ inline CreateVolumeRequest& WithTagSpecifications(Aws::Vector&& value) { SetTagSpecifications(std::move(value)); return *this;} /** *

The tags to apply to the volume during creation.

*/ inline CreateVolumeRequest& AddTagSpecifications(const TagSpecification& value) { m_tagSpecificationsHasBeenSet = true; m_tagSpecifications.push_back(value); return *this; } /** *

The tags to apply to the volume during creation.

*/ inline CreateVolumeRequest& AddTagSpecifications(TagSpecification&& value) { m_tagSpecificationsHasBeenSet = true; m_tagSpecifications.push_back(std::move(value)); return *this; } /** *

Specifies whether to enable Amazon EBS Multi-Attach. If you enable * Multi-Attach, you can attach the volume to up to 16 Nitro-based * instances in the same Availability Zone. For more information, see * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User * Guide.

*/ inline bool GetMultiAttachEnabled() const{ return m_multiAttachEnabled; } /** *

*/ inline bool MultiAttachEnabledHasBeenSet() const { return m_multiAttachEnabledHasBeenSet; } /** *

*/ inline void SetMultiAttachEnabled(bool value) { m_multiAttachEnabledHasBeenSet = true; m_multiAttachEnabled = value; } /** *

*/ inline CreateVolumeRequest& WithMultiAttachEnabled(bool value) { SetMultiAttachEnabled(value); return *this;} private: Aws::String m_availabilityZone; bool m_availabilityZoneHasBeenSet; bool m_encrypted; bool m_encryptedHasBeenSet; int m_iops; bool m_iopsHasBeenSet; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet; Aws::String m_outpostArn; bool m_outpostArnHasBeenSet; int m_size; bool m_sizeHasBeenSet; Aws::String m_snapshotId; bool m_snapshotIdHasBeenSet; VolumeType m_volumeType; bool m_volumeTypeHasBeenSet; bool m_dryRun; bool m_dryRunHasBeenSet; Aws::Vector m_tagSpecifications; bool m_tagSpecificationsHasBeenSet; bool m_multiAttachEnabled; bool m_multiAttachEnabledHasBeenSet; }; } // namespace Model } // namespace EC2 } // namespace Aws