com.pulumi.aws.ebs.kotlin.VolumeArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.ebs.kotlin
import com.pulumi.aws.ebs.VolumeArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a single EBS volume.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.ebs.Volume("example", {
* availabilityZone: "us-west-2a",
* size: 40,
* tags: {
* Name: "HelloWorld",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.ebs.Volume("example",
* availability_zone="us-west-2a",
* size=40,
* tags={
* "Name": "HelloWorld",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Ebs.Volume("example", new()
* {
* AvailabilityZone = "us-west-2a",
* Size = 40,
* Tags =
* {
* { "Name", "HelloWorld" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ebs"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := ebs.NewVolume(ctx, "example", &ebs.VolumeArgs{
* AvailabilityZone: pulumi.String("us-west-2a"),
* Size: pulumi.Int(40),
* Tags: pulumi.StringMap{
* "Name": pulumi.String("HelloWorld"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:ebs:Volume
* properties:
* availabilityZone: us-west-2a
* size: 40
* tags:
* Name: HelloWorld
* ```
*
* > **NOTE:** At least one of `size` or `snapshot_id` is required when specifying an EBS volume
* ## Import
* Using `pulumi import`, import EBS Volumes using the `id`. For example:
* ```sh
* $ pulumi import aws:ebs/volume:Volume id vol-049df61146c4d7901
* ```
* @property availabilityZone The AZ where the EBS volume will exist.
* @property encrypted If true, the disk will be encrypted.
* @property finalSnapshot 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
* @property iops The amount of IOPS to provision for the disk. Only valid for `type` of `io1`, `io2` or `gp3`.
* @property kmsKeyId 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.
* @property multiAttachEnabled Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on `io1` and `io2` volumes.
* @property outpostArn The Amazon Resource Name (ARN) of the Outpost.
* @property size The size of the drive in GiBs.
* @property snapshotId A snapshot to base the EBS volume off of.
* @property tags 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.
* @property throughput 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.
* @property type The type of EBS volume. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `gp2`).
*/
public data class VolumeArgs(
public val availabilityZone: Output? = null,
public val encrypted: Output? = null,
public val finalSnapshot: Output? = null,
public val iops: Output? = null,
public val kmsKeyId: Output? = null,
public val multiAttachEnabled: Output? = null,
public val outpostArn: Output? = null,
public val size: Output? = null,
public val snapshotId: Output? = null,
public val tags: Output