Skip to content

RosDisk

This class is a base encapsulation around the ROS resource type DATASOURCE::ECS::Disk, which is used to query the information about a cloud disk.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs/datasource"
datasource.NewRosDisk(scope Construct, id *string, props RosDiskProps, enableResourcePropertyConstraint *bool) RosDisk
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


AddCondition

func AddCondition(con RosCondition)

conRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: *string

The path of the value to delete.


AddDependsOn

func AddDependsOn(target RosResource)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AddDesc

func AddDesc(desc *string)

descRequired

  • Type: *string

AddMetaData

func AddMetaData(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

AddOverride

func AddOverride(path *string, value interface{})

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: interface{}

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

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

propertyPathRequired

  • Type: *string

The path to the property.


AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

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

propertyPathRequired

  • Type: *string

The path of the property.


valueRequired

  • Type: interface{}

The value.


AddRosDependency

func AddRosDependency(target *string)

targetRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

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

policyOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

optionsOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

GetAtt

func GetAtt(attributeName *string) Reference

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

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs/datasource"
datasource.RosDisk_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs/datasource"
datasource.RosDisk_IsRosElement(x interface{}) *bool

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: interface{}

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs/datasource"
datasource.RosDisk_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

constructRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
CreationStack []string No description.
LogicalId *string The logical ID for this stack element.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType *string ROS resource type.
AttrAttachedTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrAutoSnapshotPolicyId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrBurstingEnabled github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrCategory github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrCreateTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDeleteAutoSnapshot github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDeleteWithInstance github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDescription github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDetachedTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDevice github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDiskId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrDiskName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrEnableAutomatedSnapshotPolicy github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrEnableAutoSnapshot github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrEncrypted github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrExpiredTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrImageId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrInstanceId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIops github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIopsRead github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrIopsWrite github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrKmsKeyId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMountInstanceNum github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMountInstances github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrMultiAttach github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrOperationLocks github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPaymentType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPerformanceLevel github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrPortable github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrProductCode github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrProvisionedIops github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrResourceGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrSize github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrSnapshotId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrStorageClusterId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrStorageSetId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrStorageSetPartitionNumber github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrTags github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrZoneId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
DiskId interface{} No description.
EnableResourcePropertyConstraint *bool No description.
RefreshOptions interface{} No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func LogicalId() *string
  • 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

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

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


RefRequired

func Ref() *string
  • 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

func RosOptions() IRosResourceOptions
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

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


RosResourceTypeRequired

func RosResourceType() *string
  • Type: *string

ROS resource type.


AttrAttachedTimeRequired

func AttrAttachedTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrAutoSnapshotPolicyIdRequired

func AttrAutoSnapshotPolicyId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrBurstingEnabledRequired

func AttrBurstingEnabled() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCategoryRequired

func AttrCategory() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCreateTimeRequired

func AttrCreateTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDeleteAutoSnapshotRequired

func AttrDeleteAutoSnapshot() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDeleteWithInstanceRequired

func AttrDeleteWithInstance() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDescriptionRequired

func AttrDescription() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDetachedTimeRequired

func AttrDetachedTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDeviceRequired

func AttrDevice() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDiskIdRequired

func AttrDiskId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrDiskNameRequired

func AttrDiskName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEnableAutomatedSnapshotPolicyRequired

func AttrEnableAutomatedSnapshotPolicy() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEnableAutoSnapshotRequired

func AttrEnableAutoSnapshot() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEncryptedRequired

func AttrEncrypted() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrExpiredTimeRequired

func AttrExpiredTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrImageIdRequired

func AttrImageId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrInstanceIdRequired

func AttrInstanceId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIopsRequired

func AttrIops() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIopsReadRequired

func AttrIopsRead() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIopsWriteRequired

func AttrIopsWrite() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrKmsKeyIdRequired

func AttrKmsKeyId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMountInstanceNumRequired

func AttrMountInstanceNum() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMountInstancesRequired

func AttrMountInstances() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrMultiAttachRequired

func AttrMultiAttach() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrOperationLocksRequired

func AttrOperationLocks() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPaymentTypeRequired

func AttrPaymentType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPerformanceLevelRequired

func AttrPerformanceLevel() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrPortableRequired

func AttrPortable() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrProductCodeRequired

func AttrProductCode() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrProvisionedIopsRequired

func AttrProvisionedIops() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrResourceGroupIdRequired

func AttrResourceGroupId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSizeRequired

func AttrSize() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSnapshotIdRequired

func AttrSnapshotId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrStorageClusterIdRequired

func AttrStorageClusterId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrStorageSetIdRequired

func AttrStorageSetId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrStorageSetPartitionNumberRequired

func AttrStorageSetPartitionNumber() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrTagsRequired

func AttrTags() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrZoneIdRequired

func AttrZoneId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

DiskIdRequired

func DiskId() interface{}
  • Type: interface{}

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

RefreshOptionsOptional

func RefreshOptions() interface{}
  • Type: interface{}

Constants

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

RosResourceTypeNameRequired

func RosResourceTypeName() *string
  • Type: *string

The resource type name for this resource class.