Package com.pulumi.aws.ebs

Class VolumeArgs

  • public final class VolumeArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VolumeArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static VolumeArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      static VolumeArgs.Builder builder()  
      static VolumeArgs.Builder builder​(VolumeArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> encrypted()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> finalSnapshot()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> iops()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiAttachEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> outpostArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> size()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotId()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> throughput()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        The AZ where the EBS volume will exist.

      • encrypted

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> encrypted()
        Returns:
        If true, the disk will be encrypted.

      • finalSnapshot

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> finalSnapshot()
        Returns:
        If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false

      • iops

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> iops()
        Returns:
        The amount of IOPS to provision for the disk. Only valid for `type` of `io1`, `io2` or `gp3`.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true. Note: The provider must be running with credentials which have the `GenerateDataKeyWithoutPlaintext` permission on the specified KMS key as required by the [EBS KMS CMK volume provisioning process](https://docs.aws.amazon.com/kms/latest/developerguide/services-ebs.html#ebs-cmk) to prevent a volume from being created and almost immediately deleted.

      • multiAttachEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiAttachEnabled()
        Returns:
        Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on `io1` and `io2` volumes.

      • outpostArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> outpostArn()
        Returns:
        The Amazon Resource Name (ARN) of the Outpost.

      • size

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> size()
        Returns:
        The size of the drive in GiBs.

      • snapshotId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotId()
        Returns:
        A snapshot to base the EBS volume off of.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • throughput

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> throughput()
        Returns:
        The throughput that the volume supports, in MiB/s. Only valid for `type` of `gp3`. > **NOTE:** When changing the `size`, `iops` or `type` of an instance, there are [considerations](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/considerations.html) to be aware of.

      • type

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()
        Returns:
        The type of EBS volume. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `gp2`).