Skip to content

SnapshotGroup

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

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.SnapshotGroup(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable] = None,
  disk_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  exclude_disk_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the snapshot-consistent group.
disk_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property diskIds: The IDs of cloud disk for which you want to create snapshots.
exclude_disk_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property excludeDiskIds: The IDs of cloud disk for which you do not want to create snapshots.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The instance ID.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the snapshot-consistent group.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the snapshot-consistent group belongs.
tags typing.List[TagsProperty] Property tags: Tags to attach to snapshot-consistent group.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

descriptionOptional

  • Type: typing.Union[str, 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://.

disk_idsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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.

exclude_disk_idsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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.

instance_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The instance ID.

nameOptional

  • Type: typing.Union[str, 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://.

resource_group_idOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_ecs
ros_cdk_ecs.SnapshotGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_snapshot_group_id ros_cdk_core.IResolvable Attribute SnapshotGroupId: The ID of the snapshot-consistent group.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_snapshot_group_idRequired 

attr_snapshot_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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