Skip to content

SnapshotGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECS::SnapshotGroup, which is used to create a snapshot-consistent group for cloud disks that are attached to an Elastic Compute Service (ECS) instance.

A snapshot-consistent group contains snapshots of one or more cloud disks.

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the snapshot-consistent group.
diskIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property diskIds: The IDs of cloud disk for which you want to create snapshots.
excludeDiskIds 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.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The instance ID.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the snapshot-consistent group.
resourceGroupId 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 java.util.List<TagsProperty> Property tags: Tags to attach to snapshot-consistent group.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

descriptionOptional

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

diskIdsOptional

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

excludeDiskIdsOptional

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

instanceIdOptional

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

Property instanceId: The instance ID.

nameOptional

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

resourceGroupIdOptional

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

tagsOptional

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

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

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrSnapshotGroupId com.aliyun.ros.cdk.core.IResolvable Attribute SnapshotGroupId: The ID of the snapshot-consistent group.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrSnapshotGroupIdRequired 

public IResolvable getAttrSnapshotGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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