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:
- Disk
Name string The names to use for your new Lightsail disk.
- Disk
Name string The names to use for your new Lightsail disk.
- disk
Name String The names to use for your new Lightsail disk.
- disk
Name string The names to use for your new Lightsail disk.
- disk_
name str The names to use for your new Lightsail disk.
- disk
Name String The names to use for your new Lightsail disk.
getDisk Result
The following output properties are available:
- Add
Ons List<Pulumi.Aws Native. Lightsail. Outputs. Disk Add On> An array of objects representing the add-ons to enable for the new instance.
- Attached
To string Name of the attached Lightsail Instance
- Attachment
State string Attachment State of the Lightsail disk
- Disk
Arn string - Iops int
Iops of the Lightsail disk
- Is
Attached bool Check is Disk is attached state
- Location
Pulumi.
Aws Native. Lightsail. Outputs. Disk Location - Path string
Path of the attached Disk
- Resource
Type string Resource type of Lightsail instance.
- State string
State of the Lightsail disk
- Support
Code string Support code to help identify any issues
- List<Pulumi.
Aws Native. Lightsail. Outputs. Disk Tag> An array of key-value pairs to apply to this resource.
- Add
Ons []DiskAdd On An array of objects representing the add-ons to enable for the new instance.
- Attached
To string Name of the attached Lightsail Instance
- Attachment
State string Attachment State of the Lightsail disk
- Disk
Arn string - Iops int
Iops of the Lightsail disk
- Is
Attached bool Check is Disk is attached state
- Location
Disk
Location - Path string
Path of the attached Disk
- Resource
Type string Resource type of Lightsail instance.
- State string
State of the Lightsail disk
- Support
Code string Support code to help identify any issues
- []Disk
Tag An array of key-value pairs to apply to this resource.
- add
Ons List<DiskAdd On> An array of objects representing the add-ons to enable for the new instance.
- attached
To String Name of the attached Lightsail Instance
- attachment
State String Attachment State of the Lightsail disk
- disk
Arn String - iops Integer
Iops of the Lightsail disk
- is
Attached Boolean Check is Disk is attached state
- location
Disk
Location - path String
Path of the attached Disk
- resource
Type String Resource type of Lightsail instance.
- state String
State of the Lightsail disk
- support
Code String Support code to help identify any issues
- List<Disk
Tag> An array of key-value pairs to apply to this resource.
- add
Ons DiskAdd On[] An array of objects representing the add-ons to enable for the new instance.
- attached
To string Name of the attached Lightsail Instance
- attachment
State string Attachment State of the Lightsail disk
- disk
Arn string - iops number
Iops of the Lightsail disk
- is
Attached boolean Check is Disk is attached state
- location
Disk
Location - path string
Path of the attached Disk
- resource
Type string Resource type of Lightsail instance.
- state string
State of the Lightsail disk
- support
Code string Support code to help identify any issues
- Disk
Tag[] An array of key-value pairs to apply to this resource.
- add_
ons Sequence[DiskAdd On] 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
Disk
Location - 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
- Sequence[Disk
Tag] An array of key-value pairs to apply to this resource.
- add
Ons List<Property Map> An array of objects representing the add-ons to enable for the new instance.
- attached
To String Name of the attached Lightsail Instance
- attachment
State String Attachment State of the Lightsail disk
- disk
Arn String - iops Number
Iops of the Lightsail disk
- is
Attached Boolean Check is Disk is attached state
- location Property Map
- path String
Path of the attached Disk
- resource
Type String Resource type of Lightsail instance.
- state String
State of the Lightsail disk
- support
Code String Support code to help identify any issues
- List<Property Map>
An array of key-value pairs to apply to this resource.
Supporting Types
DiskAddOn
- Add
On stringType The add-on type
- Auto
Snapshot Pulumi.Add On Request Aws Native. Lightsail. Inputs. Disk Auto Snapshot Add On - Status
Pulumi.
Aws Native. Lightsail. Disk Add On Status Status of the Addon
- Add
On stringType The add-on type
- Auto
Snapshot DiskAdd On Request Auto Snapshot Add On - Status
Disk
Add On Status Status of the Addon
- add
On StringType The add-on type
- auto
Snapshot DiskAdd On Request Auto Snapshot Add On - status
Disk
Add On Status Status of the Addon
- add
On stringType The add-on type
- auto
Snapshot DiskAdd On Request Auto Snapshot Add On - status
Disk
Add On Status Status of the Addon
- add_
on_ strtype The add-on type
- auto_
snapshot_ Diskadd_ on_ request Auto Snapshot Add On - status
Disk
Add On Status Status of the Addon
- add
On StringType The add-on type
- auto
Snapshot Property MapAdd On Request - status "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed"
Status of the Addon
DiskAddOnStatus
DiskAutoSnapshotAddOn
- Snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- Snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- snapshot
Time StringOf Day The daily time when an automatic snapshot will be created.
- snapshot
Time stringOf Day The daily time when an automatic snapshot will be created.
- snapshot_
time_ strof_ day The daily time when an automatic snapshot will be created.
- snapshot
Time StringOf Day The daily time when an automatic snapshot will be created.
DiskLocation
- Availability
Zone 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.
- Region
Name string The Region Name in which to create your disk.
- Availability
Zone 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.
- Region
Name string The Region Name in which to create your disk.
- availability
Zone 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.
- region
Name String The Region Name in which to create your disk.
- availability
Zone 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.
- region
Name 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.
- availability
Zone 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.
- region
Name 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