AutoSnapshotPolicy

• Implements: IAutoSnapshotPolicy

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,
  copied_snapshots_retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  copy_encryption_configuration: typing.Union[IResolvable, CopyEncryptionConfigurationProperty] = None,
  disk_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_cross_region_copy: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  target_copy_regions: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

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.

copied_snapshots_retention_days^Optional

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

Property copiedSnapshotsRetentionDays: Retention time in days for replicated snapshots across geographies.

Range: -1: Permanent storage 1-65535: Specifies the number of days to save Default value: -1

copy_encryption_configuration^Optional

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

Property copyEncryptionConfiguration: The encryption configuration for copied snapshots.

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 (,).

enable_cross_region_copy^Optional

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

Property enableCrossRegionCopy: Whether to enable cross-region copying of snapshots.

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.

target_copy_regions^Optional

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

Property targetCopyRegions: The target region of the snapshot is replicated across geographies.

Setting a target region is currently supported.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_ecs
ros_cdk_ecs.AutoSnapshotPolicy.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_auto_snapshot_policy_id^Required

attr_auto_snapshot_policy_id: typing.Union[str, IResolvable]

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

Attribute AutoSnapshotPolicyId: The automatic snapshot policy ID.

props^Required

props: AutoSnapshotPolicyProps

• Type: AutoSnapshotPolicyProps