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());
    }
}

Import

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

$ pulumi import aws:ebs/volume:Volume id vol-049df61146c4d7901

Constructors

VolumeArgs

fun VolumeArgs(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)

Functions

toJava

open override fun toJava(): VolumeArgs

Properties

availabilityZone

val availabilityZone: Output<String>? = null

The AZ where the EBS volume will exist.

encrypted

val encrypted: Output<Boolean>? = null

If true, the disk will be encrypted.

finalSnapshot

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

iops

val iops: Output<Int>? = null

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

kmsKeyId

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.

multiAttachEnabled

val multiAttachEnabled: Output<Boolean>? = null

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

outpostArn

val outpostArn: Output<String>? = null

The Amazon Resource Name (ARN) of the Outpost.

size

val size: Output<Int>? = null

The size of the drive in GiBs.

snapshotId

val snapshotId: Output<String>? = null

A snapshot to base the EBS volume off of.