Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. Disk

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.Disk

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Lightsail::Disk

Create Disk Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Disk(name: string, args: DiskArgs, opts?: CustomResourceOptions);
@overload
def Disk(resource_name: str,
         args: DiskArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Disk(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         size_in_gb: Optional[int] = None,
         add_ons: Optional[Sequence[DiskAddOnArgs]] = None,
         availability_zone: Optional[str] = None,
         disk_name: Optional[str] = None,
         location: Optional[DiskLocationArgs] = None,
         tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDisk(ctx *Context, name string, args DiskArgs, opts ...ResourceOption) (*Disk, error)
public Disk(string name, DiskArgs args, CustomResourceOptions? opts = null)
public Disk(String name, DiskArgs args)
public Disk(String name, DiskArgs args, CustomResourceOptions options)

type: aws-native:lightsail:Disk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DiskArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DiskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DiskArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Disk Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Disk resource accepts the following input properties:

SizeInGb This property is required. int
Size of the Lightsail disk
AddOns List<Pulumi.AwsNative.Lightsail.Inputs.DiskAddOn>
An array of objects representing the add-ons to enable for the new instance.
AvailabilityZone string
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
DiskName string
The names to use for your new Lightsail disk.
Location Pulumi.AwsNative.Lightsail.Inputs.DiskLocation
The AWS Region and Availability Zone where the disk is located.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
SizeInGb This property is required. int
Size of the Lightsail disk
AddOns []DiskAddOnArgs
An array of objects representing the add-ons to enable for the new instance.
AvailabilityZone string
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
DiskName string
The names to use for your new Lightsail disk.
Location DiskLocationArgs
The AWS Region and Availability Zone where the disk is located.
Tags TagArgs
An array of key-value pairs to apply to this resource.
sizeInGb This property is required. Integer
Size of the Lightsail disk
addOns List<DiskAddOn>
An array of objects representing the add-ons to enable for the new instance.
availabilityZone String
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
diskName String
The names to use for your new Lightsail disk.
location DiskLocation
The AWS Region and Availability Zone where the disk is located.
tags List<Tag>
An array of key-value pairs to apply to this resource.
sizeInGb This property is required. number
Size of the Lightsail disk
addOns DiskAddOn[]
An array of objects representing the add-ons to enable for the new instance.
availabilityZone string
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
diskName string
The names to use for your new Lightsail disk.
location DiskLocation
The AWS Region and Availability Zone where the disk is located.
tags Tag[]
An array of key-value pairs to apply to this resource.
size_in_gb This property is required. int
Size of the Lightsail disk
add_ons Sequence[DiskAddOnArgs]
An array of objects representing the add-ons to enable for the new instance.
availability_zone str
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
disk_name str
The names to use for your new Lightsail disk.
location DiskLocationArgs
The AWS Region and Availability Zone where the disk is located.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
sizeInGb This property is required. Number
Size of the Lightsail disk
addOns List<Property Map>
An array of objects representing the add-ons to enable for the new instance.
availabilityZone String
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
diskName String
The names to use for your new Lightsail disk.
location Property Map
The AWS Region and Availability Zone where the disk is located.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Disk resource produces the following output properties:

AttachedTo string
Name of the attached Lightsail Instance
AttachmentState string
Attachment State of the Lightsail disk
DiskArn string
The Amazon Resource Name (ARN) of the disk.
Id string
The provider-assigned unique ID for this managed resource.
Iops int
Iops of the Lightsail disk
IsAttached bool
Check is Disk is attached state
Path string
Path of the attached Disk
ResourceType string
Resource type of Lightsail instance.
State string
State of the Lightsail disk
SupportCode string
Support code to help identify any issues
AttachedTo string
Name of the attached Lightsail Instance
AttachmentState string
Attachment State of the Lightsail disk
DiskArn string
The Amazon Resource Name (ARN) of the disk.
Id string
The provider-assigned unique ID for this managed resource.
Iops int
Iops of the Lightsail disk
IsAttached bool
Check is Disk is attached state
Path string
Path of the attached Disk
ResourceType string
Resource type of Lightsail instance.
State string
State of the Lightsail disk
SupportCode string
Support code to help identify any issues
attachedTo String
Name of the attached Lightsail Instance
attachmentState String
Attachment State of the Lightsail disk
diskArn String
The Amazon Resource Name (ARN) of the disk.
id String
The provider-assigned unique ID for this managed resource.
iops Integer
Iops of the Lightsail disk
isAttached Boolean
Check is Disk is attached state
path String
Path of the attached Disk
resourceType String
Resource type of Lightsail instance.
state String
State of the Lightsail disk
supportCode String
Support code to help identify any issues
attachedTo string
Name of the attached Lightsail Instance
attachmentState string
Attachment State of the Lightsail disk
diskArn string
The Amazon Resource Name (ARN) of the disk.
id string
The provider-assigned unique ID for this managed resource.
iops number
Iops of the Lightsail disk
isAttached boolean
Check is Disk is attached state
path string
Path of the attached Disk
resourceType string
Resource type of Lightsail instance.
state string
State of the Lightsail disk
supportCode string
Support code to help identify any issues
attached_to str
Name of the attached Lightsail Instance
attachment_state str
Attachment State of the Lightsail disk
disk_arn str
The Amazon Resource Name (ARN) of the disk.
id str
The provider-assigned unique ID for this managed resource.
iops int
Iops of the Lightsail disk
is_attached bool
Check is Disk is attached state
path str
Path of the attached Disk
resource_type str
Resource type of Lightsail instance.
state str
State of the Lightsail disk
support_code str
Support code to help identify any issues
attachedTo String
Name of the attached Lightsail Instance
attachmentState String
Attachment State of the Lightsail disk
diskArn String
The Amazon Resource Name (ARN) of the disk.
id String
The provider-assigned unique ID for this managed resource.
iops Number
Iops of the Lightsail disk
isAttached Boolean
Check is Disk is attached state
path String
Path of the attached Disk
resourceType String
Resource type of Lightsail instance.
state String
State of the Lightsail disk
supportCode String
Support code to help identify any issues

Supporting Types

DiskAddOn
, DiskAddOnArgs

AddOnType This property is required. string
The add-on type
AutoSnapshotAddOnRequest Pulumi.AwsNative.Lightsail.Inputs.DiskAutoSnapshotAddOn
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
Status Pulumi.AwsNative.Lightsail.DiskAddOnStatus
Status of the Addon
AddOnType This property is required. string
The add-on type
AutoSnapshotAddOnRequest DiskAutoSnapshotAddOn
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
Status DiskAddOnStatus
Status of the Addon
addOnType This property is required. String
The add-on type
autoSnapshotAddOnRequest DiskAutoSnapshotAddOn
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
status DiskAddOnStatus
Status of the Addon
addOnType This property is required. string
The add-on type
autoSnapshotAddOnRequest DiskAutoSnapshotAddOn
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
status DiskAddOnStatus
Status of the Addon
add_on_type This property is required. str
The add-on type
auto_snapshot_add_on_request DiskAutoSnapshotAddOn
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
status DiskAddOnStatus
Status of the Addon
addOnType This property is required. String
The add-on type
autoSnapshotAddOnRequest Property Map
The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
status "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed"
Status of the Addon

DiskAddOnStatus
, DiskAddOnStatusArgs

Enabling
Enabling
Disabling
Disabling
Enabled
Enabled
Terminating
Terminating
Terminated
Terminated
Disabled
Disabled
Failed
Failed
DiskAddOnStatusEnabling
Enabling
DiskAddOnStatusDisabling
Disabling
DiskAddOnStatusEnabled
Enabled
DiskAddOnStatusTerminating
Terminating
DiskAddOnStatusTerminated
Terminated
DiskAddOnStatusDisabled
Disabled
DiskAddOnStatusFailed
Failed
Enabling
Enabling
Disabling
Disabling
Enabled
Enabled
Terminating
Terminating
Terminated
Terminated
Disabled
Disabled
Failed
Failed
Enabling
Enabling
Disabling
Disabling
Enabled
Enabled
Terminating
Terminating
Terminated
Terminated
Disabled
Disabled
Failed
Failed
ENABLING
Enabling
DISABLING
Disabling
ENABLED
Enabled
TERMINATING
Terminating
TERMINATED
Terminated
DISABLED
Disabled
FAILED
Failed
"Enabling"
Enabling
"Disabling"
Disabling
"Enabled"
Enabled
"Terminating"
Terminating
"Terminated"
Terminated
"Disabled"
Disabled
"Failed"
Failed

DiskAutoSnapshotAddOn
, DiskAutoSnapshotAddOnArgs

SnapshotTimeOfDay string
The daily time when an automatic snapshot will be created.
SnapshotTimeOfDay string
The daily time when an automatic snapshot will be created.
snapshotTimeOfDay String
The daily time when an automatic snapshot will be created.
snapshotTimeOfDay string
The daily time when an automatic snapshot will be created.
snapshot_time_of_day str
The daily time when an automatic snapshot will be created.
snapshotTimeOfDay String
The daily time when an automatic snapshot will be created.

DiskLocation
, DiskLocationArgs

AvailabilityZone string
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
RegionName string
The Region Name in which to create your disk.
AvailabilityZone string
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
RegionName string
The Region Name in which to create your disk.
availabilityZone String
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
regionName String
The Region Name in which to create your disk.
availabilityZone string
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
regionName string
The Region Name in which to create your disk.
availability_zone str
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
region_name str
The Region Name in which to create your disk.
availabilityZone String
The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
regionName String
The Region Name in which to create your disk.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native