AWS Native v0.63.0, May 25 23

aws-native.lightsail.getDisk

Explore with Pulumi AI

Resource Type definition for AWS::Lightsail::Disk

Using getDisk

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDisk(args: GetDiskArgs, opts?: InvokeOptions): Promise<GetDiskResult>
function getDiskOutput(args: GetDiskOutputArgs, opts?: InvokeOptions): Output<GetDiskResult>

def get_disk(disk_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetDiskResult
def get_disk_output(disk_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetDiskResult]

func LookupDisk(ctx *Context, args *LookupDiskArgs, opts ...InvokeOption) (*LookupDiskResult, error)
func LookupDiskOutput(ctx *Context, args *LookupDiskOutputArgs, opts ...InvokeOption) LookupDiskResultOutput

> Note: This function is named LookupDisk in the Go SDK.

public static class GetDisk 
{
    public static Task<GetDiskResult> InvokeAsync(GetDiskArgs args, InvokeOptions? opts = null)
    public static Output<GetDiskResult> Invoke(GetDiskInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDiskResult> getDisk(GetDiskArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:lightsail:getDisk
  arguments:
    # arguments dictionary

The following arguments are supported:

DiskName string: The names to use for your new Lightsail disk.

DiskName string: The names to use for your new Lightsail disk.

diskName String: The names to use for your new Lightsail disk.

diskName string: The names to use for your new Lightsail disk.

disk_name str: The names to use for your new Lightsail disk.

diskName String: The names to use for your new Lightsail disk.

getDisk Result

The following output properties are available:

AddOns List<Pulumi.AwsNative.Lightsail.Outputs.DiskAddOn>: An array of objects representing the add-ons to enable for the new instance.
AttachedTo string: Name of the attached Lightsail Instance
AttachmentState string: Attachment State of the Lightsail disk
DiskArn string
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
Tags List<Pulumi.AwsNative.Lightsail.Outputs.DiskTag>: An array of key-value pairs to apply to this resource.

AddOns []DiskAddOn: An array of objects representing the add-ons to enable for the new instance.
AttachedTo string: Name of the attached Lightsail Instance
AttachmentState string: Attachment State of the Lightsail disk
DiskArn string
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
Tags []DiskTag: An array of key-value pairs to apply to this resource.

addOns List<DiskAddOn>: An array of objects representing the add-ons to enable for the new instance.
attachedTo String: Name of the attached Lightsail Instance
attachmentState String: Attachment State of the Lightsail disk
diskArn String
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
tags List<DiskTag>: An array of key-value pairs to apply to this resource.

addOns DiskAddOn[]: An array of objects representing the add-ons to enable for the new instance.
attachedTo string: Name of the attached Lightsail Instance
attachmentState string: Attachment State of the Lightsail disk
diskArn string
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
tags DiskTag[]: An array of key-value pairs to apply to this resource.

add_ons Sequence[DiskAddOn]: An array of objects representing the add-ons to enable for the new instance.
attached_to str: Name of the attached Lightsail Instance
attachment_state str: Attachment State of the Lightsail disk
disk_arn str
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
tags Sequence[DiskTag]: An array of key-value pairs to apply to this resource.

addOns List<Property Map>: An array of objects representing the add-ons to enable for the new instance.
attachedTo String: Name of the attached Lightsail Instance
attachmentState String: Attachment State of the Lightsail disk
diskArn String
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
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Supporting Types

DiskAddOn

AddOnType string: The add-on type
AutoSnapshotAddOnRequest Pulumi.AwsNative.Lightsail.Inputs.DiskAutoSnapshotAddOn
Status Pulumi.AwsNative.Lightsail.DiskAddOnStatus: Status of the Addon

AddOnType string: The add-on type
AutoSnapshotAddOnRequest DiskAutoSnapshotAddOn
Status DiskAddOnStatus: Status of the Addon

addOnType String: The add-on type
autoSnapshotAddOnRequest DiskAutoSnapshotAddOn
status DiskAddOnStatus: Status of the Addon

addOnType string: The add-on type
autoSnapshotAddOnRequest DiskAutoSnapshotAddOn
status DiskAddOnStatus: Status of the Addon

add_on_type str: The add-on type
auto_snapshot_add_on_request DiskAutoSnapshotAddOn
status DiskAddOnStatus: Status of the Addon

addOnType String: The add-on type
autoSnapshotAddOnRequest Property Map
status "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed": Status of the Addon

DiskAddOnStatus

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: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0