Skip to content

ParameterGroup

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::ParameterGroup, which is used to create a parameter template of PolarDB.

Initializers

import { ParameterGroup } from '@alicloud/ros-cdk-polardb'
new ParameterGroup(scope: Construct, id: string, props: ParameterGroupProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props ParameterGroupProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { ParameterGroup } from '@alicloud/ros-cdk-polardb'
ParameterGroup.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the parameter template was created.
attrDbType @alicloud/ros-cdk-core.IResolvable Attribute DbType: The type of the database engine.
attrDbVersion @alicloud/ros-cdk-core.IResolvable Attribute DbVersion: The version of the database engine.
attrForceRestart @alicloud/ros-cdk-core.IResolvable Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
attrParameterCounts @alicloud/ros-cdk-core.IResolvable Attribute ParameterCounts: The number of parameters in the parameter template.
attrParameterGroupDesc @alicloud/ros-cdk-core.IResolvable Attribute ParameterGroupDesc: The description of the parameter template.
attrParameterGroupId @alicloud/ros-cdk-core.IResolvable Attribute ParameterGroupId: The ID of the parameter group.
attrParameterGroupName @alicloud/ros-cdk-core.IResolvable Attribute ParameterGroupName: The name of the parameter template.
attrParameterGroupType @alicloud/ros-cdk-core.IResolvable Attribute ParameterGroupType: The type of the parameter template.
attrParameters @alicloud/ros-cdk-core.IResolvable Attribute Parameters: The list of the parameters.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCreateTimeRequired

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the parameter template was created.


attrDbTypeRequired

public readonly attrDbType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbType: The type of the database engine.


attrDbVersionRequired

public readonly attrDbVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbVersion: The version of the database engine.


attrForceRestartRequired

public readonly attrForceRestart: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.


attrParameterCountsRequired

public readonly attrParameterCounts: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrParameterGroupDescRequired

public readonly attrParameterGroupDesc: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ParameterGroupDesc: The description of the parameter template.


attrParameterGroupIdRequired

public readonly attrParameterGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ParameterGroupId: The ID of the parameter group.


attrParameterGroupNameRequired

public readonly attrParameterGroupName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ParameterGroupName: The name of the parameter template.


attrParameterGroupTypeRequired

public readonly attrParameterGroupType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ParameterGroupType: The type of the parameter template.


attrParametersRequired

public readonly attrParameters: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Parameters: The list of the parameters.