ParameterGroup
- Implements: com.aliyun.ros.cdk.polardb.datasource.IParameterGroup
This class encapsulates and extends the ROS resource type DATASOURCE::POLARDB::ParameterGroup.
Initializers
import com.aliyun.ros.cdk.polardb.datasource.ParameterGroup;
ParameterGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.parameterGroupId(java.lang.String)
.parameterGroupId(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. |
parameterGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property parameterGroupId: The ID of the parameter template. |
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
parameterGroupIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property parameterGroupId: The ID of the parameter template.
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.
- 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.polardb.datasource.ParameterGroup;
ParameterGroup.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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the parameter template was created. |
attrDbType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbType: The type of the database engine. |
attrDbVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbVersion: The version of the database engine. |
attrForceRestart | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied. |
attrParameterCounts | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterCounts: The number of parameters in the parameter template. |
attrParameterGroupDesc | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterGroupDesc: The description of the parameter template. |
attrParameterGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterGroupId: The ID of the parameter template. |
attrParameterGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterGroupName: The name of the parameter template. |
attrParameterGroupType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterGroupType: The type of the parameter template. |
attrParameters | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Parameters: Details about the parameter templates. |
props | ParameterGroupProps | 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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the parameter template was created.
The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
attrDbTypeRequired
public java.lang.Object getAttrDbType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbType: The type of the database engine.
attrDbVersionRequired
public java.lang.Object getAttrDbVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbVersion: The version of the database engine.
attrForceRestartRequired
public java.lang.Object getAttrForceRestart();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
Valid values: 0: A restart is not required. 1: A restart is required.
attrParameterCountsRequired
public java.lang.Object getAttrParameterCounts();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterCounts: The number of parameters in the parameter template.
attrParameterGroupDescRequired
public java.lang.Object getAttrParameterGroupDesc();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterGroupDesc: The description of the parameter template.
attrParameterGroupIdRequired
public java.lang.Object getAttrParameterGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterGroupId: The ID of the parameter template.
attrParameterGroupNameRequired
public java.lang.Object getAttrParameterGroupName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterGroupName: The name of the parameter template.
attrParameterGroupTypeRequired
public java.lang.Object getAttrParameterGroupType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterGroupType: The type of the parameter template.
Valid values: 0: the default parameter template. 1: a custom parameter template. 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.
attrParametersRequired
public java.lang.Object getAttrParameters();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Parameters: Details about the parameter templates.
propsRequired
public ParameterGroupProps getProps();
- Type: ParameterGroupProps