Skip to content

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.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_snapshot_policy_idRequired

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

Property autoSnapshotPolicyId: The name of the automatic snapshot policy.


refresh_optionsOptional

  • 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_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

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

xRequired

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

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_auto_snapshot_policy_nameRequired

attr_auto_snapshot_policy_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoSnapshotPolicyName: Name of the automatic snapshot policy.


attr_create_timeRequired

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_numsRequired

attr_disk_nums: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskNums: Number of cloud disks with this policy enabled.


attr_repeat_weekdaysRequired

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_idRequired

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attr_retention_daysRequired

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_tagsRequired

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the automatic snapshot policy.


attr_time_pointsRequired

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_numsRequired

attr_volume_nums: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VolumeNums: The number of extended volumes to which the automatic snapshot policy is applied.