Skip to content

ParameterGroup

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.
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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • 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.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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 com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the parameter template was created.
attrDbType com.aliyun.ros.cdk.core.IResolvable Attribute DbType: The type of the database engine.
attrDbVersion com.aliyun.ros.cdk.core.IResolvable Attribute DbVersion: The version of the database engine.
attrForceRestart com.aliyun.ros.cdk.core.IResolvable Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
attrParameterCounts com.aliyun.ros.cdk.core.IResolvable Attribute ParameterCounts: The number of parameters in the parameter template.
attrParameterGroupDesc com.aliyun.ros.cdk.core.IResolvable Attribute ParameterGroupDesc: The description of the parameter template.
attrParameterGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ParameterGroupId: The ID of the parameter template.
attrParameterGroupName com.aliyun.ros.cdk.core.IResolvable Attribute ParameterGroupName: The name of the parameter template.
attrParameterGroupType com.aliyun.ros.cdk.core.IResolvable Attribute ParameterGroupType: The type of the parameter template.
attrParameters com.aliyun.ros.cdk.core.IResolvable Attribute Parameters: Details about the parameter templates.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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 IResolvable getAttrCreateTime();
  • Type: 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 IResolvable getAttrDbType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbType: The type of the database engine.

attrDbVersionRequired 

public IResolvable getAttrDbVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbVersion: The version of the database engine.

attrForceRestartRequired 

public IResolvable getAttrForceRestart();
  • Type: 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 IResolvable getAttrParameterCounts();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterCounts: The number of parameters in the parameter template.

attrParameterGroupDescRequired 

public IResolvable getAttrParameterGroupDesc();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterGroupDesc: The description of the parameter template.

attrParameterGroupIdRequired 

public IResolvable getAttrParameterGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterGroupId: The ID of the parameter template.

attrParameterGroupNameRequired 

public IResolvable getAttrParameterGroupName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterGroupName: The name of the parameter template.

attrParameterGroupTypeRequired 

public IResolvable getAttrParameterGroupType();
  • Type: 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 IResolvable getAttrParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Parameters: Details about the parameter templates.