ParameterGroup
- Implements: IParameterGroup
This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::ParameterGroup.
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
- Type: ParameterGroupProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the parameter template was created. |
attrDbType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbType: The type of the database engine. |
attrDbVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbVersion: The version of the database engine. |
attrForceRestart | string | @alicloud/ros-cdk-core.IResolvable | Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied. |
attrParameterCounts | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterCounts: The number of parameters in the parameter template. |
attrParameterGroupDesc | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterGroupDesc: The description of the parameter template. |
attrParameterGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterGroupId: The ID of the parameter group. |
attrParameterGroupName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterGroupName: The name of the parameter template. |
attrParameterGroupType | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterGroupType: The type of the parameter template. |
attrParameters | string | @alicloud/ros-cdk-core.IResolvable | Attribute Parameters: The list of the parameters. |
props | ParameterGroupProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time when the parameter template was created.
attrDbTypeRequired
public readonly attrDbType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbType: The type of the database engine.
attrDbVersionRequired
public readonly attrDbVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbVersion: The version of the database engine.
attrForceRestartRequired
public readonly attrForceRestart: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
attrParameterCountsRequired
public readonly attrParameterCounts: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterCounts: The number of parameters in the parameter template.
attrParameterGroupDescRequired
public readonly attrParameterGroupDesc: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterGroupDesc: The description of the parameter template.
attrParameterGroupIdRequired
public readonly attrParameterGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterGroupId: The ID of the parameter group.
attrParameterGroupNameRequired
public readonly attrParameterGroupName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterGroupName: The name of the parameter template.
attrParameterGroupTypeRequired
public readonly attrParameterGroupType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterGroupType: The type of the parameter template.
attrParametersRequired
public readonly attrParameters: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Parameters: The list of the parameters.
propsRequired
public readonly props: ParameterGroupProps;
- Type: ParameterGroupProps