SnapshotGroup

• Implements: ISnapshotGroup

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

Initializers

import com.aliyun.ros.cdk.ecs.SnapshotGroup;
SnapshotGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskIds(IResolvable)
//  .diskIds(java.util.List<java.lang.String)
//  .diskIds(IResolvable>)
//  .excludeDiskIds(IResolvable)
//  .excludeDiskIds(java.util.List<java.lang.String)
//  .excludeDiskIds(IResolvable>)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

description^Optional

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

Property description: The description of the snapshot-consistent group.

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

diskIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property diskIds: The IDs of cloud disk for which you want to create snapshots.

You can specify multiple cloud disk IDs across instances within the same zone. The length of the list ranges from 1 to 16. A single snapshot-consistent group can contain snapshots of up to 16 cloud disks whose total disk size does not exceed 32 TiB. Take note of the following items: You cannot specify both DiskIds and ExcludeDiskIdin the same request. If InstanceId is set, you can use DiskIds to specify only cloud disks attached to the instance specified by InstanceId, and you cannot use DiskIds to specify cloud disks attached to multiple instances.

excludeDiskIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property excludeDiskIds: The IDs of cloud disk for which you do not want to create snapshots.

If this parameter is specified, the created snapshot-consistent group does not contain snapshots of the cloud disk. The length of the list ranges from 1 to 16. This parameter is empty by default, which indicates that snapshots are created for all the disks of the instance. Note You cannot specify ExcludeDiskIds and DiskIds in the same request.

instanceId^Optional

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

Property instanceId: The instance ID.

name^Optional

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

Property name: The name of the snapshot-consistent group.

The name must be 2 to 128 characters in length. The name can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:). It must start with a letter and cannot start with http:// or https://.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group to which the snapshot-consistent group belongs.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to snapshot-consistent group.

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

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

attrSnapshotGroupId^Required

public java.lang.Object getAttrSnapshotGroupId();

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

Attribute SnapshotGroupId: The ID of the snapshot-consistent group.

props^Required

public SnapshotGroupProps getProps();

• Type: SnapshotGroupProps