com.aliyun.ros.cdk.polardb.datasource.DBClusters Maven / Gradle / Ivy
package com.aliyun.ros.cdk.polardb.datasource;
/**
* This class encapsulates and extends the ROS resource type DATASOURCE::POLARDB::DBClusters, which is used to query the information about PolarDB clusters.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-12-13T06:45:10.627Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.polardb.$Module.class, fqn = "@alicloud/ros-cdk-polardb.datasource.DBClusters")
public class DBClusters extends com.aliyun.ros.cdk.core.Resource {
protected DBClusters(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected DBClusters(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* 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
* @param enableResourcePropertyConstraint
*/
public DBClusters(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.Nullable com.aliyun.ros.cdk.polardb.datasource.DBClustersProps 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"), props, enableResourcePropertyConstraint });
}
/**
* 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
*/
public DBClusters(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.Nullable com.aliyun.ros.cdk.polardb.datasource.DBClustersProps 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"), props });
}
/**
* 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.
*/
public DBClusters(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
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") });
}
/**
* Attribute DbClusterIds: The ID of the cluster.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrDbClusterIds() {
return software.amazon.jsii.Kernel.get(this, "attrDbClusterIds", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute DBClusters: The list of db clusters.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrDbClusters() {
return software.amazon.jsii.Kernel.get(this, "attrDbClusters", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
protected @org.jetbrains.annotations.NotNull java.lang.Boolean getEnableResourcePropertyConstraint() {
return software.amazon.jsii.Kernel.get(this, "enableResourcePropertyConstraint", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
protected void setEnableResourcePropertyConstraint(final @org.jetbrains.annotations.NotNull java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableResourcePropertyConstraint", java.util.Objects.requireNonNull(value, "enableResourcePropertyConstraint is required"));
}
protected @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
protected void setId(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "id", java.util.Objects.requireNonNull(value, "id is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.polardb.datasource.DBClustersProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.polardb.datasource.DBClustersProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.polardb.datasource.DBClustersProps value) {
software.amazon.jsii.Kernel.set(this, "props", java.util.Objects.requireNonNull(value, "props is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.Construct.class));
}
protected void setScope(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct value) {
software.amazon.jsii.Kernel.set(this, "scope", java.util.Objects.requireNonNull(value, "scope is required"));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.polardb.datasource.DBClusters}.
*/
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 com.aliyun.ros.cdk.polardb.datasource.DBClustersProps.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;
}
/**
* Property dbClusterId: The ID of the cluster.
*
* @return {@code this}
* @param dbClusterId Property dbClusterId: The ID of the cluster. This parameter is required.
*/
public Builder dbClusterId(final java.lang.String dbClusterId) {
this.props().dbClusterId(dbClusterId);
return this;
}
/**
* Property dbClusterId: The ID of the cluster.
*
* @return {@code this}
* @param dbClusterId Property dbClusterId: The ID of the cluster. This parameter is required.
*/
public Builder dbClusterId(final com.aliyun.ros.cdk.core.IResolvable dbClusterId) {
this.props().dbClusterId(dbClusterId);
return this;
}
/**
* Property dbType: The database engine that the cluster runs.
*
* @return {@code this}
* @param dbType Property dbType: The database engine that the cluster runs. This parameter is required.
*/
public Builder dbType(final java.lang.String dbType) {
this.props().dbType(dbType);
return this;
}
/**
* Property dbType: The database engine that the cluster runs.
*
* @return {@code this}
* @param dbType Property dbType: The database engine that the cluster runs. This parameter is required.
*/
public Builder dbType(final com.aliyun.ros.cdk.core.IResolvable dbType) {
this.props().dbType(dbType);
return this;
}
/**
* Property dbVersion: The version of the database engine that the cluster runs.
*
* The range of the MySQL version number is as follows:
* *** 5.6 * * *
* *** 5.7 * * *
* *** 8.0 * * *
* The value range of PostgreSQL version number is as follows:
* *** 11 * * *
* *** 14 * * *
* The Oracle version number is 11.
*
* @return {@code this}
* @param dbVersion Property dbVersion: The version of the database engine that the cluster runs. This parameter is required.
*/
public Builder dbVersion(final java.lang.String dbVersion) {
this.props().dbVersion(dbVersion);
return this;
}
/**
* Property dbVersion: The version of the database engine that the cluster runs.
*
* The range of the MySQL version number is as follows:
* *** 5.6 * * *
* *** 5.7 * * *
* *** 8.0 * * *
* The value range of PostgreSQL version number is as follows:
* *** 11 * * *
* *** 14 * * *
* The Oracle version number is 11.
*
* @return {@code this}
* @param dbVersion Property dbVersion: The version of the database engine that the cluster runs. This parameter is required.
*/
public Builder dbVersion(final com.aliyun.ros.cdk.core.IResolvable dbVersion) {
this.props().dbVersion(dbVersion);
return this;
}
/**
* Property description: The description of the cluster.
*
* @return {@code this}
* @param description Property description: The description of the cluster. This parameter is required.
*/
public Builder description(final java.lang.String description) {
this.props().description(description);
return this;
}
/**
* Property description: The description of the cluster.
*
* @return {@code this}
* @param description Property description: The description of the cluster. This parameter is required.
*/
public Builder description(final com.aliyun.ros.cdk.core.IResolvable description) {
this.props().description(description);
return this;
}
/**
* Property expired: Indicates whether the cluster has expired.
*
* Valid values:
* true
* false
*
* @return {@code this}
* @param expired Property expired: Indicates whether the cluster has expired. This parameter is required.
*/
public Builder expired(final java.lang.String expired) {
this.props().expired(expired);
return this;
}
/**
* Property expired: Indicates whether the cluster has expired.
*
* Valid values:
* true
* false
*
* @return {@code this}
* @param expired Property expired: Indicates whether the cluster has expired. This parameter is required.
*/
public Builder expired(final com.aliyun.ros.cdk.core.IResolvable expired) {
this.props().expired(expired);
return this;
}
/**
* 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.
*
*
* @return {@code this}
* @param refreshOptions Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. This parameter is required.
*/
public Builder refreshOptions(final java.lang.String refreshOptions) {
this.props().refreshOptions(refreshOptions);
return this;
}
/**
* 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.
*
*
* @return {@code this}
* @param refreshOptions Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. This parameter is required.
*/
public Builder refreshOptions(final com.aliyun.ros.cdk.core.IResolvable refreshOptions) {
this.props().refreshOptions(refreshOptions);
return this;
}
/**
* Property resourceGroupId: The ID of the resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of the 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 the resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of the resource group. This parameter is required.
*/
public Builder resourceGroupId(final com.aliyun.ros.cdk.core.IResolvable resourceGroupId) {
this.props().resourceGroupId(resourceGroupId);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.polardb.datasource.DBClusters}.
*/
@Override
public com.aliyun.ros.cdk.polardb.datasource.DBClusters build() {
return new com.aliyun.ros.cdk.polardb.datasource.DBClusters(
this.scope,
this.id,
this.props != null ? this.props.build() : null,
this.enableResourcePropertyConstraint
);
}
private com.aliyun.ros.cdk.polardb.datasource.DBClustersProps.Builder props() {
if (this.props == null) {
this.props = new com.aliyun.ros.cdk.polardb.datasource.DBClustersProps.Builder();
}
return this.props;
}
}
}