EnterpriseDBClusterBackupPolicy
- Implements: IEnterpriseDBClusterBackupPolicy
This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::EnterpriseDBClusterBackupPolicy.
Initializers
import com.aliyun.ros.cdk.clickhouse.EnterpriseDBClusterBackupPolicy;
EnterpriseDBClusterBackupPolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.backupRetentionPeriod(java.lang.Number)
.backupRetentionPeriod(IResolvable)
.dbInstanceId(java.lang.String)
.dbInstanceId(IResolvable)
.preferredBackupPeriod(java.lang.String)
.preferredBackupPeriod(IResolvable)
.preferredBackupTime(java.lang.String)
.preferredBackupTime(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. |
backupRetentionPeriod | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property backupRetentionPeriod: The number of days for which you can retain the backup data. |
dbInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbInstanceId: The cluster ID. |
preferredBackupPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property preferredBackupPeriod: The backup cycle, which indicates the day of the week when the system regularly backs up data. |
preferredBackupTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property preferredBackupTime: The backup time window within which the backup task is performed. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
backupRetentionPeriodRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property backupRetentionPeriod: The number of days for which you can retain the backup data.
dbInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbInstanceId: The cluster ID.
preferredBackupPeriodRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property preferredBackupPeriod: The backup cycle, which indicates the day of the week when the system regularly backs up data.
Separate multiple dates with commas (,).
preferredBackupTimeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property preferredBackupTime: The backup time window within which the backup task is performed.
The time is displayed in UTC. For example, 12:00Z-13:00Z indicates that the backup time window ranges from 12:00 (UTC) to 13:00 (UTC).
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.clickhouse.EnterpriseDBClusterBackupPolicy;
EnterpriseDBClusterBackupPolicy.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrBackupRetentionPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupRetentionPeriod: The number of days for which you can retain the backup data. |
attrBackupState | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupState: Backup switch. |
attrPreferredBackupPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PreferredBackupPeriod: The backup cycle. |
attrPreferredBackupTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PreferredBackupTime: The backup time window within which the backup task is performed. |
props | EnterpriseDBClusterBackupPolicyProps | 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
attrBackupRetentionPeriodRequired
public java.lang.Object getAttrBackupRetentionPeriod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupRetentionPeriod: The number of days for which you can retain the backup data.
attrBackupStateRequired
public java.lang.Object getAttrBackupState();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupState: Backup switch.
attrPreferredBackupPeriodRequired
public java.lang.Object getAttrPreferredBackupPeriod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PreferredBackupPeriod: The backup cycle.
attrPreferredBackupTimeRequired
public java.lang.Object getAttrPreferredBackupTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PreferredBackupTime: The backup time window within which the backup task is performed.
propsRequired
public EnterpriseDBClusterBackupPolicyProps getProps();