Skip to content

RosDisk

This class is a base encapsulation around the ROS resource type DATASOURCE::ECS::Disk.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new RosDisk(Construct Scope, string Id, RosDiskProps Props, bool EnableResourcePropertyConstraint);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct - scope in which this resource is defined.
Id string - scoped id of the resource.
Props RosDiskProps - resource properties.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.


IdRequired

  • Type: string

scoped id of the resource.


PropsRequired

resource properties.


EnableResourcePropertyConstraintRequired

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

SessionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • Type: string

The path of the value to delete.


AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

TargetRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

PathRequired

  • Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


ValueRequired

  • Type: object

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPathRequired

  • Type: string

The path to the property.


AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

PolicyOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

OptionsOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeNameRequired

  • Type: string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Ecs;
RosDisk.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Ecs;
RosDisk.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

XRequired

  • Type: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Ecs;
RosDisk.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
CreationStack string[] No description.
LogicalId string The logical ID for this stack element.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this element is defined.
Ref string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType string ROS resource type.
AttrAttachedTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrAutoSnapshotPolicyId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrBurstingEnabled AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrCategory AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrCreateTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDeleteAutoSnapshot AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDeleteWithInstance AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDetachedTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDevice AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDiskId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDiskName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrEnableAutomatedSnapshotPolicy AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrEnableAutoSnapshot AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrEncrypted AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrExpiredTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrImageId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrInstanceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrIops AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrIopsRead AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrIopsWrite AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrKmsKeyId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMountInstanceNum AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMountInstances AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMultiAttach AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrOperationLocks AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPaymentType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPerformanceLevel AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPortable AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrProductCode AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrProvisionedIops AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrResourceGroupId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSize AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSnapshotId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrStorageClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrStorageSetId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrStorageSetPartitionNumber AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTags AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrZoneId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
DiskId object No description.
EnableResourcePropertyConstraint bool No description.
RefreshOptions object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

public string LogicalId { get; }
  • Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

public string Ref { get; }
  • Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


RosOptionsRequired

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrAttachedTimeRequired

public IResolvable AttrAttachedTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrAutoSnapshotPolicyIdRequired

public IResolvable AttrAutoSnapshotPolicyId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrBurstingEnabledRequired

public IResolvable AttrBurstingEnabled { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrCategoryRequired

public IResolvable AttrCategory { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrCreateTimeRequired

public IResolvable AttrCreateTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDeleteAutoSnapshotRequired

public IResolvable AttrDeleteAutoSnapshot { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDeleteWithInstanceRequired

public IResolvable AttrDeleteWithInstance { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDescriptionRequired

public IResolvable AttrDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDetachedTimeRequired

public IResolvable AttrDetachedTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDeviceRequired

public IResolvable AttrDevice { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDiskIdRequired

public IResolvable AttrDiskId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDiskNameRequired

public IResolvable AttrDiskName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrEnableAutomatedSnapshotPolicyRequired

public IResolvable AttrEnableAutomatedSnapshotPolicy { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrEnableAutoSnapshotRequired

public IResolvable AttrEnableAutoSnapshot { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrEncryptedRequired

public IResolvable AttrEncrypted { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrExpiredTimeRequired

public IResolvable AttrExpiredTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrImageIdRequired

public IResolvable AttrImageId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrInstanceIdRequired

public IResolvable AttrInstanceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrIopsRequired

public IResolvable AttrIops { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrIopsReadRequired

public IResolvable AttrIopsRead { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrIopsWriteRequired

public IResolvable AttrIopsWrite { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrKmsKeyIdRequired

public IResolvable AttrKmsKeyId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMountInstanceNumRequired

public IResolvable AttrMountInstanceNum { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMountInstancesRequired

public IResolvable AttrMountInstances { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMultiAttachRequired

public IResolvable AttrMultiAttach { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOperationLocksRequired

public IResolvable AttrOperationLocks { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPaymentTypeRequired

public IResolvable AttrPaymentType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPerformanceLevelRequired

public IResolvable AttrPerformanceLevel { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPortableRequired

public IResolvable AttrPortable { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrProductCodeRequired

public IResolvable AttrProductCode { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrProvisionedIopsRequired

public IResolvable AttrProvisionedIops { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrResourceGroupIdRequired

public IResolvable AttrResourceGroupId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSizeRequired

public IResolvable AttrSize { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSnapshotIdRequired

public IResolvable AttrSnapshotId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrStorageClusterIdRequired

public IResolvable AttrStorageClusterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrStorageSetIdRequired

public IResolvable AttrStorageSetId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrStorageSetPartitionNumberRequired

public IResolvable AttrStorageSetPartitionNumber { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTagsRequired

public IResolvable AttrTags { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrZoneIdRequired

public IResolvable AttrZoneId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

DiskIdRequired

public object DiskId { get; }
  • Type: object

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

RefreshOptionsOptional

public object RefreshOptions { get; }
  • Type: object

Constants

Name Type Description
RosResourceTypeName string The resource type name for this resource class.

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.