Show / Hide Table of Contents

Class CfnDiskProps

Properties for defining a CfnDisk.

Inheritance
object
CfnDiskProps
Implements
ICfnDiskProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDiskProps : ICfnDiskProps
Syntax (vb)
Public Class CfnDiskProps Implements ICfnDiskProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html

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

CfnDiskProps()

Properties for defining a CfnDisk.

Properties

AddOns

An array of add-ons for the disk.

AvailabilityZone

The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).

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

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

Constructors

CfnDiskProps()

Properties for defining a CfnDisk.

public CfnDiskProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html

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 cfnDiskProps = 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"
                 } }
             };

Properties

AddOns

An array of add-ons for the disk.

public object? AddOns { get; set; }
Property Value

object

Remarks
If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-addons

AvailabilityZone

The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).

public string? AvailabilityZone { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-availabilityzone

DiskName

The name of the disk.

public string DiskName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-diskname

Location

The AWS Region and Availability Zone where the disk is located.

public object? Location { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-location

SizeInGb

The size of the disk in GB.

public double SizeInGb { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-sizeingb

Tags

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

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

For more information, see Tag in the AWS CloudFormation User Guide .

The <code>Value</code> of <code>Tags</code> is optional for Lightsail resources.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-tags

Implements

ICfnDiskProps
Back to top Generated by DocFX