OssBackupPlan

• Implements: IOssBackupPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::OssBackupPlan.

Initializers

import com.aliyun.ros.cdk.hbr.OssBackupPlan;
OssBackupPlan.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .backupType(java.lang.String)
    .backupType(IResolvable)
    .bucket(java.lang.String)
    .bucket(IResolvable)
    .planName(java.lang.String)
    .planName(IResolvable)
    .retention(java.lang.Number)
    .retention(IResolvable)
    .schedule(java.lang.String)
    .schedule(IResolvable)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
//  .crossAccountRoleName(java.lang.String)
//  .crossAccountRoleName(IResolvable)
//  .crossAccountType(java.lang.String)
//  .crossAccountType(IResolvable)
//  .crossAccountUserId(java.lang.String)
//  .crossAccountUserId(IResolvable)
//  .disabled(java.lang.Boolean)
//  .disabled(IResolvable)
//  .prefix(java.lang.String)
//  .prefix(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

backupType^Required

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

Property backupType: Backup type.

Valid values: COMPLETE.

bucket^Required

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

Property bucket: The name of OSS bucket.

planName^Required

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

Property planName: The name of the backup plan.

1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.

retention^Required

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

Property retention: Backup retention days, the minimum is 1.

schedule^Required

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

Property schedule: The backup policy.

The format is I|{startTime}|{interval}. This specifies that a backup job runs at an interval of {interval}, starting from {startTime}. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.

• startTime: The start time for the backup, specified as a UNIX timestamp in seconds.
• interval: The backup interval, specified in the ISO 8601 duration format. For example, PT1H represents one hour and P1D represents one day.

vaultId^Required

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

Property vaultId: The ID of backup vault.

crossAccountRoleName^Optional

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

Property crossAccountRoleName: The role name created in the original account RAM backup by the cross account managed by the current account.

crossAccountType^Optional

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

Property crossAccountType: The type of the cross account backup.

Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.

crossAccountUserId^Optional

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

Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.

disabled^Optional

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

Property disabled: Whether to disable the backup task.

Valid values: true, false.

prefix^Optional

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

Property prefix: Backup prefix.

Once specified, only objects with matching prefixes will be backed up.

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.hbr.OssBackupPlan;
OssBackupPlan.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

attrPlanId^Required

public java.lang.Object getAttrPlanId();

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

Attribute PlanId: The ID of the backup plan.

props^Required

public OssBackupPlanProps getProps();

• Type: OssBackupPlanProps