Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. ec2
  5. Volume

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.Volume

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Specifies an Amazon Elastic Block Store (Amazon EBS) volume. When you use CFNlong 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. CFNlong 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 on the coo

    Create Volume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           availability_zone: Optional[str] = None,
           auto_enable_io: Optional[bool] = None,
           encrypted: Optional[bool] = None,
           iops: Optional[int] = None,
           kms_key_id: Optional[str] = None,
           multi_attach_enabled: Optional[bool] = None,
           outpost_arn: Optional[str] = None,
           size: Optional[int] = None,
           snapshot_id: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           throughput: Optional[int] = None,
           volume_type: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

    type: aws-native:ec2:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const volumeResource = new aws_native.ec2.Volume("volumeResource", {
    availabilityZone: "string",
    autoEnableIo: false,
    encrypted: false,
    iops: 0,
    kmsKeyId: "string",
    multiAttachEnabled: false,
    outpostArn: "string",
    size: 0,
    snapshotId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    throughput: 0,
    volumeType: "string",
});

    Coming soon!

    Volume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Volume resource accepts the following input properties:

    AvailabilityZone string
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    AutoEnableIo bool
    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.
    Encrypted bool
    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 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.
    Iops int

    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. 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.

    KmsKeyId string
    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.
    MultiAttachEnabled bool
    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.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    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
    SnapshotId string
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to apply to the volume during creation.
    Throughput int
    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.
    VolumeType string

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    AvailabilityZone string
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    AutoEnableIo bool
    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.
    Encrypted bool
    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 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.
    Iops int

    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. 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.

    KmsKeyId string
    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.
    MultiAttachEnabled bool
    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.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    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
    SnapshotId string
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    Tags TagArgs
    The tags to apply to the volume during creation.
    Throughput int
    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.
    VolumeType string

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    availabilityZone String
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    autoEnableIo Boolean
    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.
    encrypted Boolean
    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 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.
    iops Integer

    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. 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.

    kmsKeyId String
    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.
    multiAttachEnabled Boolean
    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.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Integer
    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
    snapshotId String
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    tags List<Tag>
    The tags to apply to the volume during creation.
    throughput Integer
    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.
    volumeType String

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    availabilityZone string
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    autoEnableIo boolean
    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.
    encrypted boolean
    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 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.
    iops number

    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. 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.

    kmsKeyId string
    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.
    multiAttachEnabled boolean
    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.
    outpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    size number
    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
    snapshotId string
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    tags Tag[]
    The tags to apply to the volume during creation.
    throughput number
    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.
    volumeType string

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    availability_zone str
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    auto_enable_io bool
    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.
    encrypted bool
    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 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.
    iops int

    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. 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.

    kms_key_id str
    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.
    multi_attach_enabled bool
    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.
    outpost_arn str
    The Amazon Resource Name (ARN) of the Outpost.
    size int
    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
    snapshot_id str
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    tags Sequence[TagArgs]
    The tags to apply to the volume during creation.
    throughput int
    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.
    volume_type str

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    availabilityZone String
    The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
    autoEnableIo Boolean
    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.
    encrypted Boolean
    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 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.
    iops Number

    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. 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.

    kmsKeyId String
    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.
    multiAttachEnabled Boolean
    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.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Number
    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
    snapshotId String
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    tags List<Property Map>
    The tags to apply to the volume during creation.
    throughput Number
    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.
    volumeType String

    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 in the Amazon Elastic Compute Cloud User Guide. Default: gp2

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeId string
    Id string
    The provider-assigned unique ID for this managed resource.
    VolumeId string
    id String
    The provider-assigned unique ID for this managed resource.
    volumeId String
    id string
    The provider-assigned unique ID for this managed resource.
    volumeId string
    id str
    The provider-assigned unique ID for this managed resource.
    volume_id str
    id String
    The provider-assigned unique ID for this managed resource.
    volumeId String

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native