Snapshots

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Snapshots, which is used to query all snapshots of an Elastic Compute Service (ECS) instance or a disk.

Initializers

from ros_cdk_ecs import datasource
datasource.Snapshots(
  scope: Construct,
  id: str,
  category: typing.Union[str, IResolvable] = None,
  disk_id: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  filters: typing.Union[IResolvable, typing.List[typing.Union[FiltersProperty, IResolvable]]] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  snapshot_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  snapshot_link_id: typing.Union[str, IResolvable] = None,
  snapshot_name: typing.Union[str, IResolvable] = None,
  snapshot_type: typing.Union[str, IResolvable] = None,
  source_disk_type: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  usage: 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.
`category`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property category: The category of the snapshot.
`disk_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property diskId: The ID of the disk.
`encrypted`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property encrypted: Specifies whether the snapshot is encrypted.
`filters`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosSnapshots.FiltersProperty, ros_cdk_core.IResolvable]]]`	Property filters: Filter value when querying resources.
`instance_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceId: The ID of the instance.
`kms_key_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.
`refresh_options`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
`resource_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property resourceGroupId: The ID of the resource group to which the snapshot belongs.
`snapshot_ids`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property snapshotIds: The IDs of snapshots.
`snapshot_link_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property snapshotLinkId: The ID of the snapshot chain.
`snapshot_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property snapshotName: The name of the snapshot.
`snapshot_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property snapshotType: Specifies whether the snapshot has been used to create images or disks.
`source_disk_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property sourceDiskType: The type of the source disk for which the snapshot was created.
`status`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property status: The status of the snapshot.
`tags`	`typing.List[ros_cdk_ecs.datasource.RosSnapshots.TagsProperty]`	Property tags: Tags of snapshot.
`usage`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property usage: The type of the snapshot.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`category`^Optional

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

Property category: The category of the snapshot.

Valid values: Standard: normal snapshot Flash: local snapshot The local snapshot feature is replaced by the instant access feature. When you specify this parameter, take note of the following items: If you have used local snapshots before December 14, 2020, you can use this parameter. If you have not used local snapshots before December 14, 2020, you cannot use this parameter. Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.

`disk_id`^Optional

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

Property diskId: The ID of the disk.

`encrypted`^Optional

Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property encrypted: Specifies whether the snapshot is encrypted.

Default value: false.

`filters`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosSnapshots.FiltersProperty, ros_cdk_core.IResolvable]]]

Property filters: Filter value when querying resources.

`instance_id`^Optional

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

Property instanceId: The ID of the instance.

`kms_key_id`^Optional

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

Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.

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

`resource_group_id`^Optional

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

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

If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

`snapshot_ids`^Optional

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

Property snapshotIds: The IDs of snapshots.

The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).

`snapshot_link_id`^Optional

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

Property snapshotLinkId: The ID of the snapshot chain.

`snapshot_name`^Optional

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

Property snapshotName: The name of the snapshot.

`snapshot_type`^Optional

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

Property snapshotType: Specifies whether the snapshot has been used to create images or disks.

Valid values: auto: automatic snapshot user: manual snapshot all: all snapshot types

`source_disk_type`^Optional

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

Property sourceDiskType: The type of the source disk for which the snapshot was created.

Valid values: System: system disk Data: data disk Note These values are case-insensitive.

`status`^Optional

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

Property status: The status of the snapshot.

Default value: all. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot fails to be created. all: all snapshot statuses.

`tags`^Optional

Type: typing.List[ros_cdk_ecs.datasource.RosSnapshots.TagsProperty]

Property tags: Tags of snapshot.

`usage`^Optional

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

Property usage: The type of the snapshot.

Default value: all. Valid values: image: The snapshot has been used to create custom images. disk: The snapshot has been used to create disks. image_disk: The snapshot has been used to create custom images and data disks. none: The snapshot has not been used to create custom images or disks.

`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.Snapshots.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_ids`	`ros_cdk_core.IResolvable`	Attribute SnapshotIds: the list of snapshot ids.
`attr_snapshots`	`ros_cdk_core.IResolvable`	Attribute Snapshots: the list of snapshots.

`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_ids`^Required

attr_snapshot_ids: IResolvable

Type: ros_cdk_core.IResolvable

Attribute SnapshotIds: the list of snapshot ids.

`attr_snapshots`^Required

attr_snapshots: IResolvable

Type: ros_cdk_core.IResolvable

Attribute Snapshots: the list of snapshots.

Snapshots

Initializers

scopeRequired

idRequired

categoryOptional

disk_idOptional

encryptedOptional

filtersOptional

instance_idOptional

kms_key_idOptional

refresh_optionsOptional

resource_group_idOptional

snapshot_idsOptional

snapshot_link_idOptional

snapshot_nameOptional

snapshot_typeOptional

source_disk_typeOptional

statusOptional

tagsOptional

usageOptional

enable_resource_property_constraintOptional