AutoSnapshotPolicy
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::AutoSnapshotPolicy
.
Initializers
from ros_cdk_ecs import datasource
datasource.AutoSnapshotPolicy(
scope: Construct,
id: str,
auto_snapshot_policy_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. |
auto_snapshot_policy_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property autoSnapshotPolicyId: The name of the automatic snapshot policy. |
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
auto_snapshot_policy_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property autoSnapshotPolicyId: The name of the automatic snapshot policy.
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.
- 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
from ros_cdk_ecs import datasource
datasource.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_name |
ros_cdk_core.IResolvable |
Attribute AutoSnapshotPolicyName: Name of the automatic snapshot policy. |
attr_create_time |
ros_cdk_core.IResolvable |
Attribute CreateTime: The time when the automatic snapshot policy was created. |
attr_disk_nums |
ros_cdk_core.IResolvable |
Attribute DiskNums: Number of cloud disks with this policy enabled. |
attr_repeat_weekdays |
ros_cdk_core.IResolvable |
Attribute RepeatWeekdays: The days of the week on which to create automatic snapshots. |
attr_resource_group_id |
ros_cdk_core.IResolvable |
Attribute ResourceGroupId: The ID of the resource group. |
attr_retention_days |
ros_cdk_core.IResolvable |
Attribute RetentionDays: The retention period of the automatic snapshot. |
attr_tags |
ros_cdk_core.IResolvable |
Attribute Tags: The tags of the automatic snapshot policy. |
attr_time_points |
ros_cdk_core.IResolvable |
Attribute TimePoints: The time when the automatic snapshot policy was created. |
attr_volume_nums |
ros_cdk_core.IResolvable |
Attribute VolumeNums: The number of extended volumes to which the automatic snapshot policy is applied. |
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_name
Required
attr_auto_snapshot_policy_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute AutoSnapshotPolicyName: Name of the automatic snapshot policy.
attr_create_time
Required
attr_create_time: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute CreateTime: The time when the automatic snapshot policy was created.
The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
attr_disk_nums
Required
attr_disk_nums: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DiskNums: Number of cloud disks with this policy enabled.
attr_repeat_weekdays
Required
attr_repeat_weekdays: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute RepeatWeekdays: The days of the week on which to create automatic snapshots.
Valid values: 1 to 7, which correspond to the days of the week. 1 indicates Monday. One or more days can be specified.
attr_resource_group_id
Required
attr_resource_group_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attr_retention_days
Required
attr_retention_days: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute RetentionDays: The retention period of the automatic snapshot.
Unit: days. Valid values:
- -1: The automatic snapshot is retained until it is deleted.
- 1 to 65536: The automatic snapshot is retained for the specified number of days.
attr_tags
Required
attr_tags: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Tags: The tags of the automatic snapshot policy.
attr_time_points
Required
attr_time_points: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute TimePoints: The time when the automatic snapshot policy was created.
The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
attr_volume_nums
Required
attr_volume_nums: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute VolumeNums: The number of extended volumes to which the automatic snapshot policy is applied.