Snapshot

• Implements: ISnapshot

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Snapshot.

Initializers

import com.aliyun.ros.cdk.ecs.Snapshot;
Snapshot.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .diskId(java.lang.String)
    .diskId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .instantAccess(java.lang.Boolean)
//  .instantAccess(IResolvable)
//  .instantAccessRetentionDays(java.lang.Number)
//  .instantAccessRetentionDays(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .retentionDays(java.lang.Number)
//  .retentionDays(IResolvable)
//  .snapshotName(java.lang.String)
//  .snapshotName(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeout(java.lang.Number)
//  .timeout(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

diskId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property diskId: Indicates the ID of the specified disk.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The snapshot description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

This parameter is empty by default.

instantAccess^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property instantAccess: Specifies whether to enable the Instant Access feature.

Valid values:

• true: Enables the Instant Access feature. This feature can be enabled only for snapshots of ESSD cloud disks.
• false: Disables the Instant Access feature. A standard snapshot is created. Default value: false.

This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.

instantAccessRetentionDays^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property instantAccessRetentionDays: The retention period for the Instant Access feature, in days.

The snapshot is automatically deleted when this retention period expires. This parameter takes effect only when InstantAccess is set to true. Valid values: 1 to 65,535. Defaults to the value of RetentionDays.

This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

retentionDays^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property retentionDays: The retention period of the snapshot, in days.

Valid values: 1 to 65,536. The snapshot is automatically deleted when the retention period expires. If this parameter is not specified, the snapshot is retained indefinitely.

snapshotName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property snapshotName: The snapshot name must be 2 to 128 characters long.

It must start with a letter or a Chinese character and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

The name cannot start with http:\/\/ or https:\/\/. To avoid conflicts with auto snapshot names, the name cannot start with auto.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

timeout^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeout: The number of minutes to wait for create snapshot.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

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

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ecs.Snapshot;
Snapshot.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrSnapshotId^Required

public java.lang.Object getAttrSnapshotId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotId: The snapshot ID.

props^Required

public SnapshotProps getProps();

• Type: SnapshotProps