pulumi-aws-kotlin/com.pulumi.aws.ebs.kotlin/VolumeArgs

VolumeArgs

data class VolumeArgs(val availabilityZone: Output<String>? = null, val encrypted: Output<Boolean>? = null, val finalSnapshot: Output<Boolean>? = null, val iops: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val multiAttachEnabled: Output<Boolean>? = null, val outpostArn: Output<String>? = null, val size: Output<Int>? = null, val snapshotId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val throughput: Output<Int>? = null, val type: Output<String>? = null) : ConvertibleToJava<VolumeArgs>

Manages a single EBS volume.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ebs.Volume;
import com.pulumi.aws.ebs.VolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Volume("example", VolumeArgs.builder()
            .availabilityZone("us-west-2a")
            .size(40)
            .tags(Map.of("Name", "HelloWorld"))
            .build());
    }
}
Content copied to clipboard

Import

EBS Volumes can be imported using the id, e.g.,

$ pulumi import aws:ebs/volume:Volume id vol-049df61146c4d7901
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(availabilityZone: Output<String>? = null, encrypted: Output<Boolean>? = null, finalSnapshot: Output<Boolean>? = null, iops: Output<Int>? = null, kmsKeyId: Output<String>? = null, multiAttachEnabled: Output<Boolean>? = null, outpostArn: Output<String>? = null, size: Output<Int>? = null, snapshotId: Output<String>? = null, tags: Output<Map<String, String>>? = null, throughput: Output<Int>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard
val availabilityZone: Output<String>? = null

The AZ where the EBS volume will exist.

Link copied to clipboard
val encrypted: Output<Boolean>? = null

If true, the disk will be encrypted.

Link copied to clipboard
val finalSnapshot: Output<Boolean>? = null

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

Link copied to clipboard
val iops: Output<Int>? = null

The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.

Link copied to clipboard
val kmsKeyId: Output<String>? = null

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 to prevent a volume from being created and almost immediately deleted.

Link copied to clipboard
val multiAttachEnabled: Output<Boolean>? = null

Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.

Link copied to clipboard
val outpostArn: Output<String>? = null

The Amazon Resource Name (ARN) of the Outpost.

Link copied to clipboard
val size: Output<Int>? = null

The size of the drive in GiBs.

Link copied to clipboard
val snapshotId: Output<String>? = null

A snapshot to base the EBS volume off of.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val throughput: Output<Int>? = null

The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

Link copied to clipboard
val type: Output<String>? = null

The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).

Functions

Link copied to clipboard
open override fun toJava(): VolumeArgs