Disk class
Manages a Lightsail disk. Use this resource to create additional block storage that can be attached to Lightsail instances for extra storage capacity.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const available = aws.getAvailabilityZones({
filters: [{
name: "opt-in-status",
values: ["opt-in-not-required"],
}],
state: "available",
});
const example = new aws.lightsail.Disk("example", {
name: "example-disk",
sizeInGb: 8,
availabilityZone: available.then(available => available.names?.[0]),
});
import pulumi
import pulumi_aws as aws
available = aws.get_availability_zones(filters=[{
"name": "opt-in-status",
"values": ["opt-in-not-required"],
}],
state="available")
example = aws.lightsail.Disk("example",
name="example-disk",
size_in_gb=8,
availability_zone=available.names[0])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var available = Aws.GetAvailabilityZones.Invoke(new()
{
Filters = new[]
{
new Aws.Inputs.GetAvailabilityZonesFilterInputArgs
{
Name = "opt-in-status",
Values = new[]
{
"opt-in-not-required",
},
},
},
State = "available",
});
var example = new Aws.LightSail.Disk("example", new()
{
Name = "example-disk",
SizeInGb = 8,
AvailabilityZone = available.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[0]),
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
available, err := aws.GetAvailabilityZones(ctx, &aws.GetAvailabilityZonesArgs{
Filters: []aws.GetAvailabilityZonesFilter{
{
Name: "opt-in-status",
Values: []string{
"opt-in-not-required",
},
},
},
State: pulumi.StringRef("available"),
}, nil)
if err != nil {
return err
}
_, err = lightsail.NewDisk(ctx, "example", &lightsail.DiskArgs{
Name: pulumi.String("example-disk"),
SizeInGb: pulumi.Int(8),
AvailabilityZone: pulumi.String(available.Names[0]),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getavailabilityzones" "available" {
filters {
name = "opt-in-status"
values = ["opt-in-not-required"]
}
state = "available"
}
resource "aws_lightsail_disk" "example" {
name = "example-disk"
size_in_gb = 8
availability_zone = data.aws_getavailabilityzones.available.names[0]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
import com.pulumi.aws.inputs.GetAvailabilityZonesFilterArgs;
import com.pulumi.aws.lightsail.Disk;
import com.pulumi.aws.lightsail.DiskArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
.filters(GetAvailabilityZonesFilterArgs.builder()
.name("opt-in-status")
.values("opt-in-not-required")
.build())
.state("available")
.build());
var example = new Disk("example", DiskArgs.builder()
.name("example-disk")
.sizeInGb(8)
.availabilityZone(available.names()[0])
.build());
}
}
resources:
example:
type: aws:lightsail:Disk
properties:
name: example-disk
sizeInGb: 8
availabilityZone: ${available.names[0]}
variables:
available:
fn::invoke:
function: aws:getAvailabilityZones
arguments:
filters:
- name: opt-in-status
values:
- opt-in-not-required
state: available
Import
Using pulumi import, import aws.lightsail.Disk using the name attribute. For example:
$ pulumi import aws:lightsail/disk:Disk example example-disk
Constructors
- Disk(String name, {DiskArgs? args, CustomResourceOptions? options})
-
Creates a new Disk.
nameThe Pulumi resource name.argsArguments used to configure this Disk. The set of arguments for Disk.optionsResource options controlling this resource's behavior. - Disk.reference(String urn)
- Creates a typed reference to an existing Disk resource.
Properties
-
arn
↔ Output<
String> -
ARN of the disk.
latefinal
-
availabilityZone
↔ Output<
String> -
Availability Zone in which to create the disk.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdAt
↔ Output<
String> -
Date and time when the disk was created.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the disk. Must begin with an alphabetic character and contain only alphanumeric characters, underscores, hyphens, and dots.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sizeInGb
↔ Output<
int> -
Size of the disk in GB.
latefinal
-
supportCode
↔ Output<
String> -
Support code for the disk. Include this code in your email to support when you have questions about a disk in Lightsail.
latefinal
-
Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited