AutoSnapshotPolicy
This class encapsulates and extends the ROS resource type ALIYUN::ECS::AutoSnapshotPolicy
, which is used to create an automatic snapshot policy.
Initializers
import ros_cdk_ecs
ros_cdk_ecs.AutoSnapshotPolicy(
scope: Construct,
id: str,
repeat_weekdays: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]],
retention_days: typing.Union[typing.Union[int, float], IResolvable],
time_points: typing.Union[typing.List[typing.Any], IResolvable],
auto_snapshot_policy_name: typing.Union[str, IResolvable] = None,
disk_ids: typing.Union[IResolvable, typing.List[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. |
repeat_weekdays |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]] |
Property repeatWeekdays: The automatic snapshot repetition dates. |
retention_days |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property retentionDays: The snapshot retention time, and the unit of measurement is day. |
time_points |
typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] |
Property timePoints: The automatic snapshot creation schedule, and the unit of measurement is hour. |
auto_snapshot_policy_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property autoSnapshotPolicyName: The name of the automatic snapshot policy. |
disk_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property diskIds: The disk ID. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: Resource group id. |
tags |
typing.List[TagsProperty] |
Property tags: Tags to attach to instance. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
repeat_weekdays
Required
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]]
Property repeatWeekdays: The automatic snapshot repetition dates.
The unit of measurement is day and the repeating cycle is a week. Value range: [1, 7], which represents days starting from Monday to Sunday, for example 1 indicates Monday. When you want to schedule multiple automatic snapshot tasks for a disk in a week, you can set the RepeatWeekdays to an array. A maximum of seven time points can be selected. The format is a list of [1, 2, ..., 7] and the time points are separated by commas (,).
retention_days
Required
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property retentionDays: The snapshot retention time, and the unit of measurement is day.
Optional values: -1: The automatic snapshots are retained permanently. [1, 65536]: The number of days retained. Default value: -1.
time_points
Required
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property timePoints: The automatic snapshot creation schedule, and the unit of measurement is hour.
Value range: [0, 23], which represents from 00:00 to 24:00, for example 1 indicates 01:00. When you want to schedule multiple automatic snapshot tasks for a disk in a day, you can set the TimePoints to an array. A maximum of 24 time points can be selected. The format is a list of [0, 1, ..., 23] and the time points are separated by commas (,).
auto_snapshot_policy_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property autoSnapshotPolicyName: The name of the automatic snapshot policy.
It can consist of [2, 128] English or Chinese characters. Must begin with an uppercase or lowercase letter or a Chinese character. Can contain numbers, periods (.), colons (:), underscores (_), and hyphens (-). Cannot start with http:// or https://. Default value: null.
disk_ids
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property diskIds: The disk ID.
When you want to apply the automatic snapshot policy to multiple disks, you can set the DiskIds to an array. The format is list of ["d-xxxxxxxxx", "d-yyyyyyyyy", ..., "d-zzzzzzzzz"] and the IDs are separated by commas (,).
resource_group_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Resource group id.
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.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- 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.AutoSnapshotPolicy.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_auto_snapshot_policy_id |
ros_cdk_core.IResolvable |
Attribute AutoSnapshotPolicyId: The automatic snapshot policy 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_auto_snapshot_policy_id
Required
attr_auto_snapshot_policy_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute AutoSnapshotPolicyId: The automatic snapshot policy ID.