Snapshot

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

Initializers

from ros_cdk_ecs import datasource
datasource.Snapshot(
  scope: Construct,
  id: str,
  snapshot_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
snapshot_id	typing.Union[str, ros_cdk_core.IResolvable]	Property snapshotId: The snapshot id.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

snapshot_id^Required

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

Property snapshotId: The snapshot id.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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

from ros_cdk_ecs import datasource
datasource.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_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The create time.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description.
attr_disk_id	ros_cdk_core.IResolvable	Attribute DiskId: The source disk id.
attr_encrypted	ros_cdk_core.IResolvable	Attribute Encrypted: Whether the snapshot is encrypted.
attr_instant_access	ros_cdk_core.IResolvable	Attribute InstantAccess: Whether snapshot speed availability is enabled.
attr_instant_access_retention_days	ros_cdk_core.IResolvable	Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.
attr_product_code	ros_cdk_core.IResolvable	Attribute ProductCode: The product number inherited from the mirror market.
attr_progress	ros_cdk_core.IResolvable	Attribute Progress: Snapshot creation progress, in percentage.
attr_remain_time	ros_cdk_core.IResolvable	Attribute RemainTime: Remaining completion time for the snapshot being created.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The resource group id.
attr_retention_days	ros_cdk_core.IResolvable	Attribute RetentionDays: Automatic snapshot retention days.
attr_snapshot_id	ros_cdk_core.IResolvable	Attribute SnapshotId: The snapshot id.
attr_snapshot_name	ros_cdk_core.IResolvable	Attribute SnapshotName: Snapshot Display Name.
attr_snapshot_sn	ros_cdk_core.IResolvable	Attribute SnapshotSN: Snapshot serial number.
attr_snapshot_type	ros_cdk_core.IResolvable	Attribute SnapshotType: Snapshot creation type.
attr_source_disk_size	ros_cdk_core.IResolvable	Attribute SourceDiskSize: Source disk capacity.
attr_source_disk_type	ros_cdk_core.IResolvable	Attribute SourceDiskType: Source disk attributes.
attr_source_storage_type	ros_cdk_core.IResolvable	Attribute SourceStorageType: Original disk type.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tags.
attr_usage	ros_cdk_core.IResolvable	Attribute Usage: A resource type that has a reference relationship.

---

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_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The create time.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description.

---

attr_disk_id^Required

attr_disk_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DiskId: The source disk id.

---

attr_encrypted^Required

attr_encrypted: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Encrypted: Whether the snapshot is encrypted.

---

attr_instant_access^Required

attr_instant_access: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstantAccess: Whether snapshot speed availability is enabled.

---

attr_instant_access_retention_days^Required

attr_instant_access_retention_days: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstantAccessRetentionDays: InstantAccessRetentionDays.

---

attr_product_code^Required

attr_product_code: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ProductCode: The product number inherited from the mirror market.

---

attr_progress^Required

attr_progress: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Progress: Snapshot creation progress, in percentage.

---

attr_remain_time^Required

attr_remain_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RemainTime: Remaining completion time for the snapshot being created.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The resource group id.

---

attr_retention_days^Required

attr_retention_days: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RetentionDays: Automatic snapshot retention days.

---

attr_snapshot_id^Required

attr_snapshot_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SnapshotId: The snapshot id.

---

attr_snapshot_name^Required

attr_snapshot_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SnapshotName: Snapshot Display Name.

---

attr_snapshot_sn^Required

attr_snapshot_sn: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SnapshotSN: Snapshot serial number.

---

attr_snapshot_type^Required

attr_snapshot_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SnapshotType: Snapshot creation type.

---

attr_source_disk_size^Required

attr_source_disk_size: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceDiskSize: Source disk capacity.

---

attr_source_disk_type^Required

attr_source_disk_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceDiskType: Source disk attributes.

---

attr_source_storage_type^Required

attr_source_storage_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceStorageType: Original disk type.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tags.

---

attr_usage^Required

attr_usage: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Usage: A resource type that has a reference relationship.

---