Skip to content

Snapshot

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

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.
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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • 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.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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 @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The create time.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description.
attrDiskId @alicloud/ros-cdk-core.IResolvable Attribute DiskId: The source disk id.
attrEncrypted @alicloud/ros-cdk-core.IResolvable Attribute Encrypted: Whether the snapshot is encrypted.
attrInstantAccess @alicloud/ros-cdk-core.IResolvable Attribute InstantAccess: Whether snapshot speed availability is enabled.
attrInstantAccessRetentionDays @alicloud/ros-cdk-core.IResolvable Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.
attrProductCode @alicloud/ros-cdk-core.IResolvable Attribute ProductCode: The product number inherited from the mirror market.
attrProgress @alicloud/ros-cdk-core.IResolvable Attribute Progress: Snapshot creation progress, in percentage.
attrRemainTime @alicloud/ros-cdk-core.IResolvable Attribute RemainTime: Remaining completion time for the snapshot being created.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The resource group id.
attrRetentionDays @alicloud/ros-cdk-core.IResolvable Attribute RetentionDays: Automatic snapshot retention days.
attrSnapshotId @alicloud/ros-cdk-core.IResolvable Attribute SnapshotId: The snapshot id.
attrSnapshotName @alicloud/ros-cdk-core.IResolvable Attribute SnapshotName: Snapshot Display Name.
attrSnapshotSn @alicloud/ros-cdk-core.IResolvable Attribute SnapshotSN: Snapshot serial number.
attrSnapshotType @alicloud/ros-cdk-core.IResolvable Attribute SnapshotType: Snapshot creation type.
attrSourceDiskSize @alicloud/ros-cdk-core.IResolvable Attribute SourceDiskSize: Source disk capacity.
attrSourceDiskType @alicloud/ros-cdk-core.IResolvable Attribute SourceDiskType: Source disk attributes.
attrSourceStorageType @alicloud/ros-cdk-core.IResolvable Attribute SourceStorageType: Original disk type.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags.
attrUsage @alicloud/ros-cdk-core.IResolvable Attribute Usage: A resource type that has a reference relationship.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The create time.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description.

attrDiskIdRequired 

public readonly attrDiskId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DiskId: The source disk id.

attrEncryptedRequired 

public readonly attrEncrypted: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Encrypted: Whether the snapshot is encrypted.

attrInstantAccessRequired 

public readonly attrInstantAccess: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstantAccess: Whether snapshot speed availability is enabled.

attrInstantAccessRetentionDaysRequired 

public readonly attrInstantAccessRetentionDays: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.

attrProductCodeRequired 

public readonly attrProductCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProductCode: The product number inherited from the mirror market.

attrProgressRequired 

public readonly attrProgress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Progress: Snapshot creation progress, in percentage.

attrRemainTimeRequired 

public readonly attrRemainTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RemainTime: Remaining completion time for the snapshot being created.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The resource group id.

attrRetentionDaysRequired 

public readonly attrRetentionDays: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RetentionDays: Automatic snapshot retention days.

attrSnapshotIdRequired 

public readonly attrSnapshotId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotId: The snapshot id.

attrSnapshotNameRequired 

public readonly attrSnapshotName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotName: Snapshot Display Name.

attrSnapshotSnRequired 

public readonly attrSnapshotSn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotSN: Snapshot serial number.

attrSnapshotTypeRequired 

public readonly attrSnapshotType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotType: Snapshot creation type.

attrSourceDiskSizeRequired 

public readonly attrSourceDiskSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceDiskSize: Source disk capacity.

attrSourceDiskTypeRequired 

public readonly attrSourceDiskType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceDiskType: Source disk attributes.

attrSourceStorageTypeRequired 

public readonly attrSourceStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceStorageType: Original disk type.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags.

attrUsageRequired 

public readonly attrUsage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Usage: A resource type that has a reference relationship.