Snapshot

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Snapshot, which is used to create a snapshot for a disk.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.Snapshot(
  scope: Construct,
  id: str,
  disk_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  instant_access: typing.Union[bool, IResolvable] = None,
  instant_access_retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  snapshot_name: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
disk_id	typing.Union[str, ros_cdk_core.IResolvable]	Property diskId: Indicates the ID of the specified disk.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of a snapshot can be 2 to 256 characters in length and cannot begin with http:\/\/ or https:\/\/.
instant_access	typing.Union[bool, ros_cdk_core.IResolvable]	Property instantAccess: Specifies whether to enable the instant access feature.
instant_access_retention_days	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property instantAccessRetentionDays: Specifies the retention period of the instant access feature.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
retention_days	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property retentionDays: Set the retention period of a snapshot in days.
snapshot_name	typing.Union[str, ros_cdk_core.IResolvable]	Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to instance.
timeout	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property timeout: The number of minutes to wait for create snapshot.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

disk_id^Required

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

Property diskId: Indicates the ID of the specified disk.

---

description^Optional

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

Property description: The description of a snapshot can be 2 to 256 characters in length and cannot begin with http:\/\/ or https:\/\/.

The description will appear on the console. By default, the value is zero.

---

instant_access^Optional

• Type: typing.Union[bool, 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 enhanced SSDs (ESSDs) false: disables the instant access feature. If InstantAccess is set to false, normal snapshots are created. Default value: false. Note This parameter and the Category parameter cannot be specified at the same time. For more information, see the "Description" section in this topic.

---

instant_access_retention_days^Optional

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

Property instantAccessRetentionDays: Specifies the retention period of the instant access feature.

After the retention period ends, the snapshot is automatically released. This parameter takes effect only when InstantAccess is set to true. Unit: days. Valid values: 1 to 65535. By default, the value of this parameter is the same as that of RetentionDays.

---

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

---

retention_days^Optional

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

Property retentionDays: Set the retention period of a snapshot in days.

The snapshot will be automatically released after the retention period expires. The value ranges from 1 to 65536.

---

snapshot_name^Optional

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

Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters.

It must begin with an uppercase/lowercase letter or a Chinese character, and may contain numbers, '_' or '-'. It cannot begin with http:// or https://.

---

tags^Optional

• Type: typing.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: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

---

enable_resource_property_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• 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.Snapshot.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_id	ros_cdk_core.IResolvable	Attribute SnapshotId: The snapshot ID.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_snapshot_id^Required

attr_snapshot_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SnapshotId: The snapshot ID.

---