Class CfnDisk
The AWS::Lightsail::Disk
resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.
Inherited Members
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDisk : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDisk
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html
CloudformationResource: AWS::Lightsail::Disk
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lightsail;
var cfnDisk = new CfnDisk(this, "MyCfnDisk", new CfnDiskProps {
DiskName = "diskName",
SizeInGb = 123,
// the properties below are optional
AddOns = new [] { new AddOnProperty {
AddOnType = "addOnType",
// the properties below are optional
AutoSnapshotAddOnRequest = new AutoSnapshotAddOnProperty {
SnapshotTimeOfDay = "snapshotTimeOfDay"
},
Status = "status"
} },
AvailabilityZone = "availabilityZone",
Location = new LocationProperty {
AvailabilityZone = "availabilityZone",
RegionName = "regionName"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDisk(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDisk(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDisk(Construct, String, ICfnDiskProps) |
Properties
AddOns | An array of add-ons for the disk. |
AttrAttachedTo | The resources to which the disk is attached. |
AttrAttachmentState | (Deprecated) The attachment state of the disk. |
AttrDiskArn | The Amazon Resource Name (ARN) of the disk. |
AttrIops | The input/output operations per second (IOPS) of the disk. |
AttrIsAttached | A Boolean value indicating whether the disk is attached. |
AttrLocationAvailabilityZone | The Availability Zone where the disk is located. |
AttrLocationRegionName | The AWS Region where the disk is located. |
AttrPath | The disk path. |
AttrResourceType | The resource type of the disk (for example, |
AttrState | The state of the disk (for example, |
AttrSupportCode | The support code of the disk. |
AvailabilityZone | The AWS Region and Availability Zone location for the disk (for example, |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DiskName | The name of the disk. |
Location | The AWS Region and Availability Zone where the disk is located. |
SizeInGb | The size of the disk in GB. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDisk(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDisk(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDisk(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDisk(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDisk(Construct, String, ICfnDiskProps)
public CfnDisk(Construct scope, string id, ICfnDiskProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDiskProps
Resource properties.
Properties
AddOns
An array of add-ons for the disk.
public virtual object AddOns { get; set; }
Property Value
System.Object
AttrAttachedTo
The resources to which the disk is attached.
public virtual string AttrAttachedTo { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AttachedTo
AttrAttachmentState
(Deprecated) The attachment state of the disk.
public virtual string AttrAttachmentState { get; }
Property Value
System.String
Remarks
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached
instead.
CloudformationAttribute: AttachmentState
AttrDiskArn
The Amazon Resource Name (ARN) of the disk.
public virtual string AttrDiskArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DiskArn
AttrIops
The input/output operations per second (IOPS) of the disk.
public virtual double AttrIops { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: Iops
AttrIsAttached
A Boolean value indicating whether the disk is attached.
public virtual IResolvable AttrIsAttached { get; }
Property Value
Remarks
CloudformationAttribute: IsAttached
AttrLocationAvailabilityZone
The Availability Zone where the disk is located.
public virtual string AttrLocationAvailabilityZone { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Location.AvailabilityZone
AttrLocationRegionName
The AWS Region where the disk is located.
public virtual string AttrLocationRegionName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Location.RegionName
AttrPath
The disk path.
public virtual string AttrPath { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Path
AttrResourceType
The resource type of the disk (for example, Disk
).
public virtual string AttrResourceType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ResourceType
AttrState
The state of the disk (for example, in-use
).
public virtual string AttrState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: State
AttrSupportCode
The support code of the disk.
public virtual string AttrSupportCode { get; }
Property Value
System.String
Remarks
Include this code in your email to support when you have questions about a disk or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
CloudformationAttribute: SupportCode
AvailabilityZone
The AWS Region and Availability Zone location for the disk (for example, us-east-1a
).
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DiskName
The name of the disk.
public virtual string DiskName { get; set; }
Property Value
System.String
Location
The AWS Region and Availability Zone where the disk is located.
public virtual object Location { get; set; }
Property Value
System.Object
SizeInGb
The size of the disk in GB.
public virtual double SizeInGb { get; set; }
Property Value
System.Double
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>