AutoSnapshotPolicy

• Implements: IAutoSnapshotPolicy

This class encapsulates and extends the ROS resource type ALIYUN::ECS::AutoSnapshotPolicy.

Initializers

import com.aliyun.ros.cdk.ecs.AutoSnapshotPolicy;
AutoSnapshotPolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .repeatWeekdays(IResolvable)
    .repeatWeekdays(java.util.List<java.lang.Number)
    .repeatWeekdays(IResolvable>)
    .retentionDays(java.lang.Number)
    .retentionDays(IResolvable)
    .timePoints(java.util.List<java.lang.Object>)
    .timePoints(IResolvable)
//  .autoSnapshotPolicyName(java.lang.String)
//  .autoSnapshotPolicyName(IResolvable)
//  .copiedSnapshotsRetentionDays(java.lang.Number)
//  .copiedSnapshotsRetentionDays(IResolvable)
//  .copyEncryptionConfiguration(IResolvable)
//  .copyEncryptionConfiguration(CopyEncryptionConfigurationProperty)
//  .diskIds(IResolvable)
//  .diskIds(java.util.List<java.lang.String)
//  .diskIds(IResolvable>)
//  .enableCrossRegionCopy(java.lang.Boolean)
//  .enableCrossRegionCopy(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .targetCopyRegions(IResolvable)
//  .targetCopyRegions(java.util.List<java.lang.String)
//  .targetCopyRegions(IResolvable>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

repeatWeekdays^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

retentionDays^Required

• Type: java.lang.Number OR com.aliyun.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.

timePoints^Required

• Type: java.util.List OR com.aliyun.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 (,).

autoSnapshotPolicyName^Optional

• Type: java.lang.String OR com.aliyun.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.

copiedSnapshotsRetentionDays^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property copiedSnapshotsRetentionDays: The retention period of the snapshot copy in the destination region.

Unit: days. Valid values:

• -1: The snapshot copy is retained until it is deleted.
• 1 to 65535: The snapshot copy is retained for the specified number of days. After the retention period of the snapshot copy expires, the snapshot copy is automatically deleted. Default value: -1.

copyEncryptionConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR CopyEncryptionConfigurationProperty

Property copyEncryptionConfiguration: The encryption configuration for copied snapshots.

diskIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

enableCrossRegionCopy^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

tags^Optional

• Type: java.util.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.

targetCopyRegions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

Setting a target region is currently supported.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ecs.AutoSnapshotPolicy;
AutoSnapshotPolicy.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrAutoSnapshotPolicyId^Required

public java.lang.Object getAttrAutoSnapshotPolicyId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AutoSnapshotPolicyId: The automatic snapshot policy ID.

props^Required

public AutoSnapshotPolicyProps getProps();

• Type: AutoSnapshotPolicyProps