Skip to content

AutoSnapshotPolicy

  • Implements: com.aliyun.ros.cdk.ecs.datasource.IAutoSnapshotPolicy

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

Initializers

import com.aliyun.ros.cdk.ecs.datasource.AutoSnapshotPolicy;
AutoSnapshotPolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .autoSnapshotPolicyId(java.lang.String)
    .autoSnapshotPolicyId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
autoSnapshotPolicyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoSnapshotPolicyId: The name of the automatic snapshot policy.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

autoSnapshotPolicyIdRequired

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

Property autoSnapshotPolicyId: The name of the automatic snapshot policy.


refreshOptionsOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAutoSnapshotPolicyName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AutoSnapshotPolicyName: Name of the automatic snapshot policy.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the automatic snapshot policy was created.
attrDiskNums java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiskNums: Number of cloud disks with this policy enabled.
attrRepeatWeekdays java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RepeatWeekdays: The days of the week on which to create automatic snapshots.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrRetentionDays java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RetentionDays: The retention period of the automatic snapshot.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags of the automatic snapshot policy.
attrTimePoints java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TimePoints: The time when the automatic snapshot policy was created.
attrVolumeNums java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VolumeNums: The number of extended volumes to which the automatic snapshot policy is applied.
props AutoSnapshotPolicyProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAutoSnapshotPolicyNameRequired

public java.lang.Object getAttrAutoSnapshotPolicyName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AutoSnapshotPolicyName: Name of the automatic snapshot policy.


attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.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.


attrDiskNumsRequired

public java.lang.Object getAttrDiskNums();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRepeatWeekdaysRequired

public java.lang.Object getAttrRepeatWeekdays();
  • Type: java.lang.String OR com.aliyun.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.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrRetentionDaysRequired

public java.lang.Object getAttrRetentionDays();
  • Type: java.lang.String OR com.aliyun.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.

attrTagsRequired

public java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of the automatic snapshot policy.


attrTimePointsRequired

public java.lang.Object getAttrTimePoints();
  • Type: java.lang.String OR com.aliyun.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.


attrVolumeNumsRequired

public java.lang.Object getAttrVolumeNums();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


propsRequired

public AutoSnapshotPolicyProps getProps();