import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Specifies an Amazon Elastic Block Store (Amazon EBS) volume. * * When you use AWS CloudFormation to update an Amazon EBS volume that modifies `Iops` , `Size` , or `VolumeType` , there is a cooldown period before another operation can occur. This can cause your stack to report being in `UPDATE_IN_PROGRESS` or `UPDATE_ROLLBACK_IN_PROGRESS` for long periods of time. * * Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback. * * Some common scenarios when you might encounter a cooldown period for Amazon EBS include: * * - You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period. * - You successfully update an Amazon EBS volume and the update succeeds but another change in your `update-stack` call fails. The rollback will be subject to a cooldown period. * * For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html) . * * *DeletionPolicy attribute* * * To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) . * * > If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot. */ export declare class Volume extends pulumi.CustomResource { /** * Get an existing Volume resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Volume; /** * Returns true if the given object is an instance of Volume. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Volume; /** * Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. */ readonly autoEnableIo: pulumi.Output; /** * The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. */ readonly availabilityZone: pulumi.Output; /** * Indicates 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](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*. * Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). */ readonly encrypted: pulumi.Output; /** * The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. * The following are the supported values for each volume type: * + ``gp3``: 3,000 - 16,000 IOPS * + ``io1``: 100 - 64,000 IOPS * + ``io2``: 100 - 256,000 IOPS * * For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS. * This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. */ readonly iops: pulumi.Output; /** * The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. * If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. * Alternatively, if you want to specify a different key, you can specify one of the following: * + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. * + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. * + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. * + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. */ readonly kmsKeyId: pulumi.Output; /** * Indicates whether Amazon EBS Multi-Attach is enabled. * CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. */ readonly multiAttachEnabled: pulumi.Output; /** * The Amazon Resource Name (ARN) of the Outpost. */ readonly outpostArn: pulumi.Output; /** * The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. * The following are the supported volumes sizes for each volume type: * + ``gp2`` and ``gp3``: 1 - 16,384 GiB * + ``io1``: 4 - 16,384 GiB * + ``io2``: 4 - 65,536 GiB * + ``st1`` and ``sc1``: 125 - 16,384 GiB * + ``standard``: 1 - 1024 GiB */ readonly size: pulumi.Output; /** * The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. */ readonly snapshotId: pulumi.Output; /** * The tags to apply to the volume during creation. */ readonly tags: pulumi.Output; /** * The throughput to provision for a volume, with a maximum of 1,000 MiB/s. * This parameter is valid only for ``gp3`` volumes. The default value is 125. * Valid Range: Minimum value of 125. Maximum value of 1000. */ readonly throughput: pulumi.Output; /** * The ID of the volume. */ readonly volumeId: pulumi.Output; /** * Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. * * This parameter is supported only for volumes created from snapshots. Omit this parameter if: * * - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. * * > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * - You want to create a volume that is initialized at the default rate. * * For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* . * * Valid range: 100 - 300 MiB/s */ readonly volumeInitializationRate: pulumi.Output; /** * The volume type. This parameter can be one of the following values: * + General Purpose SSD: ``gp2`` | ``gp3`` * + Provisioned IOPS SSD: ``io1`` | ``io2`` * + Throughput Optimized HDD: ``st1`` * + Cold HDD: ``sc1`` * + Magnetic: ``standard`` * * For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html). * Default: ``gp2`` */ readonly volumeType: pulumi.Output; /** * Create a Volume resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: VolumeArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Volume resource. */ export interface VolumeArgs { /** * Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. */ autoEnableIo?: pulumi.Input; /** * The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. */ availabilityZone: pulumi.Input; /** * Indicates 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](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*. * Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). */ encrypted?: pulumi.Input; /** * The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. * The following are the supported values for each volume type: * + ``gp3``: 3,000 - 16,000 IOPS * + ``io1``: 100 - 64,000 IOPS * + ``io2``: 100 - 256,000 IOPS * * For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS. * This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. */ iops?: pulumi.Input; /** * The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. * If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. * Alternatively, if you want to specify a different key, you can specify one of the following: * + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. * + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. * + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. * + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. */ kmsKeyId?: pulumi.Input; /** * Indicates whether Amazon EBS Multi-Attach is enabled. * CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. */ multiAttachEnabled?: pulumi.Input; /** * The Amazon Resource Name (ARN) of the Outpost. */ outpostArn?: pulumi.Input; /** * The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. * The following are the supported volumes sizes for each volume type: * + ``gp2`` and ``gp3``: 1 - 16,384 GiB * + ``io1``: 4 - 16,384 GiB * + ``io2``: 4 - 65,536 GiB * + ``st1`` and ``sc1``: 125 - 16,384 GiB * + ``standard``: 1 - 1024 GiB */ size?: pulumi.Input; /** * The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. */ snapshotId?: pulumi.Input; /** * The tags to apply to the volume during creation. */ tags?: pulumi.Input[]>; /** * The throughput to provision for a volume, with a maximum of 1,000 MiB/s. * This parameter is valid only for ``gp3`` volumes. The default value is 125. * Valid Range: Minimum value of 125. Maximum value of 1000. */ throughput?: pulumi.Input; /** * Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. * * This parameter is supported only for volumes created from snapshots. Omit this parameter if: * * - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. * * > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * - You want to create a volume that is initialized at the default rate. * * For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* . * * Valid range: 100 - 300 MiB/s */ volumeInitializationRate?: pulumi.Input; /** * The volume type. This parameter can be one of the following values: * + General Purpose SSD: ``gp2`` | ``gp3`` * + Provisioned IOPS SSD: ``io1`` | ``io2`` * + Throughput Optimized HDD: ``st1`` * + Cold HDD: ``sc1`` * + Magnetic: ``standard`` * * For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html). * Default: ``gp2`` */ volumeType?: pulumi.Input; }