com.aliyun.ros.cdk.polardbx.DBInstance Maven / Gradle / Ivy
Show all versions of ros-cdk-polardbx Show documentation
package com.aliyun.ros.cdk.polardbx;
/**
* A ROS resource type: ALIYUN::PolarDBX::DBInstance.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.84.0 (build 5404dcf)", date = "2023-06-28T08:22:29.748Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.polardbx.$Module.class, fqn = "@alicloud/ros-cdk-polardbx.DBInstance")
public class DBInstance extends com.aliyun.ros.cdk.core.Resource {
protected DBInstance(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected DBInstance(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Create a new ALIYUN::PolarDBX::DBInstance.
*
* Param scope - scope in which this resource is defined
* Param id - scoped id of the resource
* Param props - resource properties
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
* @param enableResourcePropertyConstraint
*/
public DBInstance(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.polardbx.DBInstanceProps props, final @org.jetbrains.annotations.Nullable java.lang.Boolean enableResourcePropertyConstraint) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required"), enableResourcePropertyConstraint });
}
/**
* Create a new ALIYUN::PolarDBX::DBInstance.
*
* Param scope - scope in which this resource is defined
* Param id - scoped id of the resource
* Param props - resource properties
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
public DBInstance(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.polardbx.DBInstanceProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Attribute DBInstanceName: The name of the instance that you create.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrDbInstanceName() {
return software.amazon.jsii.Kernel.get(this, "attrDbInstanceName", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute OrderId: The ID of the order.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrOrderId() {
return software.amazon.jsii.Kernel.get(this, "attrOrderId", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.polardbx.DBInstance}.
*/
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
* @param enableResourcePropertyConstraint
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
return new Builder(scope, id, enableResourcePropertyConstraint);
}
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id, null);
}
private final com.aliyun.ros.cdk.core.Construct scope;
private final java.lang.String id;
private final java.lang.Boolean enableResourcePropertyConstraint;
private final com.aliyun.ros.cdk.polardbx.DBInstanceProps.Builder props;
private Builder(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
this.scope = scope;
this.id = id;
this.enableResourcePropertyConstraint = enableResourcePropertyConstraint;
this.props = new com.aliyun.ros.cdk.polardbx.DBInstanceProps.Builder();
}
/**
* Property dbNodeClass: The specification of the nodes in the instance you want to create.
*
* @return {@code this}
* @param dbNodeClass Property dbNodeClass: The specification of the nodes in the instance you want to create. This parameter is required.
*/
public Builder dbNodeClass(final java.lang.String dbNodeClass) {
this.props.dbNodeClass(dbNodeClass);
return this;
}
/**
* Property dbNodeClass: The specification of the nodes in the instance you want to create.
*
* @return {@code this}
* @param dbNodeClass Property dbNodeClass: The specification of the nodes in the instance you want to create. This parameter is required.
*/
public Builder dbNodeClass(final com.aliyun.ros.cdk.core.IResolvable dbNodeClass) {
this.props.dbNodeClass(dbNodeClass);
return this;
}
/**
* Property dbNodeCount: The number of nodes in the instance you want to create.
*
* @return {@code this}
* @param dbNodeCount Property dbNodeCount: The number of nodes in the instance you want to create. This parameter is required.
*/
public Builder dbNodeCount(final java.lang.Number dbNodeCount) {
this.props.dbNodeCount(dbNodeCount);
return this;
}
/**
* Property dbNodeCount: The number of nodes in the instance you want to create.
*
* @return {@code this}
* @param dbNodeCount Property dbNodeCount: The number of nodes in the instance you want to create. This parameter is required.
*/
public Builder dbNodeCount(final com.aliyun.ros.cdk.core.IResolvable dbNodeCount) {
this.props.dbNodeCount(dbNodeCount);
return this;
}
/**
* Property engineVersion: The version of the database engine.
*
* @return {@code this}
* @param engineVersion Property engineVersion: The version of the database engine. This parameter is required.
*/
public Builder engineVersion(final java.lang.String engineVersion) {
this.props.engineVersion(engineVersion);
return this;
}
/**
* Property engineVersion: The version of the database engine.
*
* @return {@code this}
* @param engineVersion Property engineVersion: The version of the database engine. This parameter is required.
*/
public Builder engineVersion(final com.aliyun.ros.cdk.core.IResolvable engineVersion) {
this.props.engineVersion(engineVersion);
return this;
}
/**
* Property primaryZone: The primary zone.
*
* @return {@code this}
* @param primaryZone Property primaryZone: The primary zone. This parameter is required.
*/
public Builder primaryZone(final java.lang.String primaryZone) {
this.props.primaryZone(primaryZone);
return this;
}
/**
* Property primaryZone: The primary zone.
*
* @return {@code this}
* @param primaryZone Property primaryZone: The primary zone. This parameter is required.
*/
public Builder primaryZone(final com.aliyun.ros.cdk.core.IResolvable primaryZone) {
this.props.primaryZone(primaryZone);
return this;
}
/**
* Property topologyType: The topology type of the instance.
*
* Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.
*
* @return {@code this}
* @param topologyType Property topologyType: The topology type of the instance. This parameter is required.
*/
public Builder topologyType(final java.lang.String topologyType) {
this.props.topologyType(topologyType);
return this;
}
/**
* Property topologyType: The topology type of the instance.
*
* Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.
*
* @return {@code this}
* @param topologyType Property topologyType: The topology type of the instance. This parameter is required.
*/
public Builder topologyType(final com.aliyun.ros.cdk.core.IResolvable topologyType) {
this.props.topologyType(topologyType);
return this;
}
/**
* Property vpcId: The ID of the VPC to which the instance belongs.
*
* @return {@code this}
* @param vpcId Property vpcId: The ID of the VPC to which the instance belongs. This parameter is required.
*/
public Builder vpcId(final java.lang.String vpcId) {
this.props.vpcId(vpcId);
return this;
}
/**
* Property vpcId: The ID of the VPC to which the instance belongs.
*
* @return {@code this}
* @param vpcId Property vpcId: The ID of the VPC to which the instance belongs. This parameter is required.
*/
public Builder vpcId(final com.aliyun.ros.cdk.core.IResolvable vpcId) {
this.props.vpcId(vpcId);
return this;
}
/**
* Property vSwitchId: The ID of the vSwitch.
*
* @return {@code this}
* @param vSwitchId Property vSwitchId: The ID of the vSwitch. This parameter is required.
*/
public Builder vSwitchId(final java.lang.String vSwitchId) {
this.props.vSwitchId(vSwitchId);
return this;
}
/**
* Property vSwitchId: The ID of the vSwitch.
*
* @return {@code this}
* @param vSwitchId Property vSwitchId: The ID of the vSwitch. This parameter is required.
*/
public Builder vSwitchId(final com.aliyun.ros.cdk.core.IResolvable vSwitchId) {
this.props.vSwitchId(vSwitchId);
return this;
}
/**
* Property autoRenew: Specifies whether to enable auto-renewal for the instance.
*
* Default value: true. true: Enable auto-renewal. false: Disable auto-renewal.
*
* @return {@code this}
* @param autoRenew Property autoRenew: Specifies whether to enable auto-renewal for the instance. This parameter is required.
*/
public Builder autoRenew(final java.lang.Boolean autoRenew) {
this.props.autoRenew(autoRenew);
return this;
}
/**
* Property autoRenew: Specifies whether to enable auto-renewal for the instance.
*
* Default value: true. true: Enable auto-renewal. false: Disable auto-renewal.
*
* @return {@code this}
* @param autoRenew Property autoRenew: Specifies whether to enable auto-renewal for the instance. This parameter is required.
*/
public Builder autoRenew(final com.aliyun.ros.cdk.core.IResolvable autoRenew) {
this.props.autoRenew(autoRenew);
return this;
}
/**
* Property dbInstanceDescription: The description of the instance.
*
* @return {@code this}
* @param dbInstanceDescription Property dbInstanceDescription: The description of the instance. This parameter is required.
*/
public Builder dbInstanceDescription(final java.lang.String dbInstanceDescription) {
this.props.dbInstanceDescription(dbInstanceDescription);
return this;
}
/**
* Property dbInstanceDescription: The description of the instance.
*
* @return {@code this}
* @param dbInstanceDescription Property dbInstanceDescription: The description of the instance. This parameter is required.
*/
public Builder dbInstanceDescription(final com.aliyun.ros.cdk.core.IResolvable dbInstanceDescription) {
this.props.dbInstanceDescription(dbInstanceDescription);
return this;
}
/**
* Property payType: The billing method of the instance.
*
* Default: POSTPAY.Valid values: PREPAY: subscription POSTPAY: pay-as-you-go
*
* @return {@code this}
* @param payType Property payType: The billing method of the instance. This parameter is required.
*/
public Builder payType(final java.lang.String payType) {
this.props.payType(payType);
return this;
}
/**
* Property payType: The billing method of the instance.
*
* Default: POSTPAY.Valid values: PREPAY: subscription POSTPAY: pay-as-you-go
*
* @return {@code this}
* @param payType Property payType: The billing method of the instance. This parameter is required.
*/
public Builder payType(final com.aliyun.ros.cdk.core.IResolvable payType) {
this.props.payType(payType);
return this;
}
/**
* Property period: The unit of the billing cycle for the instance.
*
* The valid values vary based on the billing method. If you use the subscription billing method, set the value to Year or Month. If you use the pay-as-you-go billing method, the value is automatically set to Hour.
*
* @return {@code this}
* @param period Property period: The unit of the billing cycle for the instance. This parameter is required.
*/
public Builder period(final java.lang.String period) {
this.props.period(period);
return this;
}
/**
* Property period: The unit of the billing cycle for the instance.
*
* The valid values vary based on the billing method. If you use the subscription billing method, set the value to Year or Month. If you use the pay-as-you-go billing method, the value is automatically set to Hour.
*
* @return {@code this}
* @param period Property period: The unit of the billing cycle for the instance. This parameter is required.
*/
public Builder period(final com.aliyun.ros.cdk.core.IResolvable period) {
this.props.period(period);
return this;
}
/**
* Property resourceGroupId: The ID of resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of resource group. This parameter is required.
*/
public Builder resourceGroupId(final java.lang.String resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property resourceGroupId: The ID of resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of resource group. This parameter is required.
*/
public Builder resourceGroupId(final com.aliyun.ros.cdk.core.IResolvable resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property secondaryZone: The secondary zone.
*
* @return {@code this}
* @param secondaryZone Property secondaryZone: The secondary zone. This parameter is required.
*/
public Builder secondaryZone(final java.lang.String secondaryZone) {
this.props.secondaryZone(secondaryZone);
return this;
}
/**
* Property secondaryZone: The secondary zone.
*
* @return {@code this}
* @param secondaryZone Property secondaryZone: The secondary zone. This parameter is required.
*/
public Builder secondaryZone(final com.aliyun.ros.cdk.core.IResolvable secondaryZone) {
this.props.secondaryZone(secondaryZone);
return this;
}
/**
* Property tertiaryZone: The tertiary zone.
*
* @return {@code this}
* @param tertiaryZone Property tertiaryZone: The tertiary zone. This parameter is required.
*/
public Builder tertiaryZone(final java.lang.String tertiaryZone) {
this.props.tertiaryZone(tertiaryZone);
return this;
}
/**
* Property tertiaryZone: The tertiary zone.
*
* @return {@code this}
* @param tertiaryZone Property tertiaryZone: The tertiary zone. This parameter is required.
*/
public Builder tertiaryZone(final com.aliyun.ros.cdk.core.IResolvable tertiaryZone) {
this.props.tertiaryZone(tertiaryZone);
return this;
}
/**
* Property usedTime: The subscription period of the instance.
*
* Unit: month or year. Note When period is set to year, the supported values of this parameter are 1, 2 and 3.
*
* @return {@code this}
* @param usedTime Property usedTime: The subscription period of the instance. This parameter is required.
*/
public Builder usedTime(final java.lang.Number usedTime) {
this.props.usedTime(usedTime);
return this;
}
/**
* Property usedTime: The subscription period of the instance.
*
* Unit: month or year. Note When period is set to year, the supported values of this parameter are 1, 2 and 3.
*
* @return {@code this}
* @param usedTime Property usedTime: The subscription period of the instance. This parameter is required.
*/
public Builder usedTime(final com.aliyun.ros.cdk.core.IResolvable usedTime) {
this.props.usedTime(usedTime);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.polardbx.DBInstance}.
*/
@Override
public com.aliyun.ros.cdk.polardbx.DBInstance build() {
return new com.aliyun.ros.cdk.polardbx.DBInstance(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}