Snapshot
- Implements: @alicloud/ros-cdk-ecs.datasource.ISnapshot
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Snapshot.
Initializers
import { datasource } from '@alicloud/ros-cdk-ecs'
new datasource.Snapshot(scope: Construct, id: string, props: SnapshotProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | SnapshotProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: SnapshotProps
enableResourcePropertyConstraintOptional
- Type: boolean
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-ecs'
datasource.Snapshot.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The create time. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description. |
attrDiskId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DiskId: The source disk id. |
attrEncrypted | string | @alicloud/ros-cdk-core.IResolvable | Attribute Encrypted: Whether the snapshot is encrypted. |
attrInstantAccess | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstantAccess: Whether snapshot speed availability is enabled. |
attrInstantAccessRetentionDays | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstantAccessRetentionDays: InstantAccessRetentionDays. |
attrProductCode | string | @alicloud/ros-cdk-core.IResolvable | Attribute ProductCode: The product number inherited from the mirror market. |
attrProgress | string | @alicloud/ros-cdk-core.IResolvable | Attribute Progress: Snapshot creation progress, in percentage. |
attrRemainTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute RemainTime: Remaining completion time for the snapshot being created. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The resource group id. |
attrRetentionDays | string | @alicloud/ros-cdk-core.IResolvable | Attribute RetentionDays: Automatic snapshot retention days. |
attrSnapshotId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SnapshotId: The snapshot id. |
attrSnapshotName | string | @alicloud/ros-cdk-core.IResolvable | Attribute SnapshotName: Snapshot Display Name. |
attrSnapshotSn | string | @alicloud/ros-cdk-core.IResolvable | Attribute SnapshotSN: Snapshot serial number. |
attrSnapshotType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SnapshotType: Snapshot creation type. |
attrSourceDiskSize | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceDiskSize: Source disk capacity. |
attrSourceDiskType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceDiskType: Source disk attributes. |
attrSourceStorageType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SourceStorageType: Original disk type. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags. |
attrUsage | string | @alicloud/ros-cdk-core.IResolvable | Attribute Usage: A resource type that has a reference relationship. |
props | SnapshotProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/ros-cdk-core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The create time.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description.
attrDiskIdRequired
public readonly attrDiskId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DiskId: The source disk id.
attrEncryptedRequired
public readonly attrEncrypted: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Encrypted: Whether the snapshot is encrypted.
attrInstantAccessRequired
public readonly attrInstantAccess: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstantAccess: Whether snapshot speed availability is enabled.
attrInstantAccessRetentionDaysRequired
public readonly attrInstantAccessRetentionDays: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.
attrProductCodeRequired
public readonly attrProductCode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ProductCode: The product number inherited from the mirror market.
attrProgressRequired
public readonly attrProgress: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Progress: Snapshot creation progress, in percentage.
attrRemainTimeRequired
public readonly attrRemainTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RemainTime: Remaining completion time for the snapshot being created.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The resource group id.
attrRetentionDaysRequired
public readonly attrRetentionDays: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RetentionDays: Automatic snapshot retention days.
attrSnapshotIdRequired
public readonly attrSnapshotId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SnapshotId: The snapshot id.
attrSnapshotNameRequired
public readonly attrSnapshotName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SnapshotName: Snapshot Display Name.
attrSnapshotSnRequired
public readonly attrSnapshotSn: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SnapshotSN: Snapshot serial number.
attrSnapshotTypeRequired
public readonly attrSnapshotType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SnapshotType: Snapshot creation type.
attrSourceDiskSizeRequired
public readonly attrSourceDiskSize: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceDiskSize: Source disk capacity.
attrSourceDiskTypeRequired
public readonly attrSourceDiskType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceDiskType: Source disk attributes.
attrSourceStorageTypeRequired
public readonly attrSourceStorageType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SourceStorageType: Original disk type.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags.
attrUsageRequired
public readonly attrUsage: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Usage: A resource type that has a reference relationship.
propsRequired
public readonly props: SnapshotProps;
- Type: SnapshotProps