AWS Native

Pulumi Official
Package maintained by Pulumi
v0.16.1 published on Saturday, Apr 30, 2022 by Pulumi

Disk

Resource Type definition for AWS::Lightsail::Disk

Create a Disk Resource

new Disk(name: string, args: DiskArgs, opts?: CustomResourceOptions);
@overload
def Disk(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         add_ons: Optional[Sequence[DiskAddOnArgs]] = None,
         availability_zone: Optional[str] = None,
         disk_name: Optional[str] = None,
         size_in_gb: Optional[int] = None,
         tags: Optional[Sequence[DiskTagArgs]] = None)
@overload
def Disk(resource_name: str,
         args: DiskArgs,
         opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args DiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args DiskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args 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

The Disk resource accepts the following input properties:

SizeInGb int

Size of the Lightsail disk

AddOns List<Pulumi.AwsNative.Lightsail.Inputs.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.

Tags List<Pulumi.AwsNative.Lightsail.Inputs.DiskTagArgs>

An array of key-value pairs to apply to this resource.

SizeInGb 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.

Tags []DiskTagArgs

An array of key-value pairs to apply to this resource.

sizeInGb Integer

Size of the Lightsail disk

addOns ListAddOnArgs>

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.

tags ListTagArgs>

An array of key-value pairs to apply to this resource.

sizeInGb number

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.

tags DiskTagArgs[]

An array of key-value pairs to apply to this resource.

size_in_gb 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.

tags Sequence[DiskTagArgs]

An array of key-value pairs to apply to this resource.

sizeInGb Number

Size of the Lightsail disk

addOns List

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.

tags List

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
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

Location Pulumi.AwsNative.Lightsail.Outputs.DiskLocation
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
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

Location DiskLocation
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
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

location DiskLocation
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
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

location DiskLocation
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
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

location DiskLocation
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
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

location Property Map
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

DiskAddOnStatus

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

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

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.

DiskTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0