Provides a Polar Db Parameter Group resource.
For information about Polar Db Parameter Group and how to use it, see What is Parameter Group.
NOTE: Available since v1.183.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const example = new alicloud.polardb.ParameterGroup("example", {
parameterGroupName: "example_value",
dbType: "MySQL",
dbVersion: "8.0",
parameters: [{
paramName: "wait_timeout",
paramValue: "86400",
}],
description: "example_value",
});
import pulumi
import pulumi_alicloud as alicloud
example = alicloud.polardb.ParameterGroup("example",
parameter_group_name="example_value",
db_type="MySQL",
db_version="8.0",
parameters=[{
"param_name": "wait_timeout",
"param_value": "86400",
}],
description="example_value")
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := polardb.NewParameterGroup(ctx, "example", &polardb.ParameterGroupArgs{
ParameterGroupName: pulumi.String("example_value"),
DbType: pulumi.String("MySQL"),
DbVersion: pulumi.String("8.0"),
Parameters: polardb.ParameterGroupParameterArray{
&polardb.ParameterGroupParameterArgs{
ParamName: pulumi.String("wait_timeout"),
ParamValue: pulumi.String("86400"),
},
},
Description: pulumi.String("example_value"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var example = new AliCloud.PolarDB.ParameterGroup("example", new()
{
ParameterGroupName = "example_value",
DbType = "MySQL",
DbVersion = "8.0",
Parameters = new[]
{
new AliCloud.PolarDB.Inputs.ParameterGroupParameterArgs
{
ParamName = "wait_timeout",
ParamValue = "86400",
},
},
Description = "example_value",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.polardb.ParameterGroup;
import com.pulumi.alicloud.polardb.ParameterGroupArgs;
import com.pulumi.alicloud.polardb.inputs.ParameterGroupParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ParameterGroup("example", ParameterGroupArgs.builder()
.parameterGroupName("example_value")
.dbType("MySQL")
.dbVersion("8.0")
.parameters(ParameterGroupParameterArgs.builder()
.paramName("wait_timeout")
.paramValue("86400")
.build())
.description("example_value")
.build());
}
}
resources:
example:
type: alicloud:polardb:ParameterGroup
properties:
parameterGroupName: example_value
dbType: MySQL
dbVersion: '8.0'
parameters:
- paramName: wait_timeout
paramValue: '86400'
description: example_value
Create ParameterGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);@overload
def ParameterGroup(resource_name: str,
args: ParameterGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ParameterGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_type: Optional[str] = None,
db_version: Optional[str] = None,
parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
parameter_group_name: Optional[str] = None)func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)
public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)
type: alicloud:polardb:ParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ParameterGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ParameterGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ParameterGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ParameterGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ParameterGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var parameterGroupResource = new AliCloud.PolarDB.ParameterGroup("parameterGroupResource", new()
{
DbType = "string",
DbVersion = "string",
Parameters = new[]
{
new AliCloud.PolarDB.Inputs.ParameterGroupParameterArgs
{
ParamName = "string",
ParamValue = "string",
},
},
Description = "string",
ParameterGroupName = "string",
});
example, err := polardb.NewParameterGroup(ctx, "parameterGroupResource", &polardb.ParameterGroupArgs{
DbType: pulumi.String("string"),
DbVersion: pulumi.String("string"),
Parameters: polardb.ParameterGroupParameterArray{
&polardb.ParameterGroupParameterArgs{
ParamName: pulumi.String("string"),
ParamValue: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
ParameterGroupName: pulumi.String("string"),
})
var parameterGroupResource = new ParameterGroup("parameterGroupResource", ParameterGroupArgs.builder()
.dbType("string")
.dbVersion("string")
.parameters(ParameterGroupParameterArgs.builder()
.paramName("string")
.paramValue("string")
.build())
.description("string")
.parameterGroupName("string")
.build());
parameter_group_resource = alicloud.polardb.ParameterGroup("parameterGroupResource",
db_type="string",
db_version="string",
parameters=[{
"param_name": "string",
"param_value": "string",
}],
description="string",
parameter_group_name="string")
const parameterGroupResource = new alicloud.polardb.ParameterGroup("parameterGroupResource", {
dbType: "string",
dbVersion: "string",
parameters: [{
paramName: "string",
paramValue: "string",
}],
description: "string",
parameterGroupName: "string",
});
type: alicloud:polardb:ParameterGroup
properties:
dbType: string
dbVersion: string
description: string
parameterGroupName: string
parameters:
- paramName: string
paramValue: string
ParameterGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ParameterGroup resource accepts the following input properties:
- Db
Type string - The type of the database engine. Only
MySQLis supported. - Db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Parameter Group Parameter> Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- Description string
- The description of the parameter template.
- Name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- Parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- Db
Type string - The type of the database engine. Only
MySQLis supported. - Db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- Parameters
[]Parameter
Group Parameter Args Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- Description string
- The description of the parameter template.
- Name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- Parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- db
Type String - The type of the database engine. Only
MySQLis supported. - db
Version String - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- parameters
List<Parameter
Group Parameter> Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- description String
- The description of the parameter template.
- name String
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group StringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- db
Type string - The type of the database engine. Only
MySQLis supported. - db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- parameters
Parameter
Group Parameter[] Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- description string
- The description of the parameter template.
- name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- db_
type str - The type of the database engine. Only
MySQLis supported. - db_
version str - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- parameters
Sequence[Parameter
Group Parameter Args] Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- description str
- The description of the parameter template.
- name str
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter_
group_ strname The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- db
Type String - The type of the database engine. Only
MySQLis supported. - db
Version String - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- parameters List<Property Map>
Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- description String
- The description of the parameter template.
- name String
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group StringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
Outputs
All input properties are implicitly available as output properties. Additionally, the ParameterGroup resource produces the following output properties:
- Create
Time string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Create
Time string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- create
Time String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- create
Time string - 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.
- id string
- The provider-assigned unique ID for this managed resource.
- create_
time str - 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.
- id str
- The provider-assigned unique ID for this managed resource.
- create
Time String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ParameterGroup Resource
Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
db_type: Optional[str] = None,
db_version: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
parameter_group_name: Optional[str] = None,
parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None) -> ParameterGroupfunc GetParameterGroup(ctx *Context, name string, id IDInput, state *ParameterGroupState, opts ...ResourceOption) (*ParameterGroup, error)public static ParameterGroup Get(string name, Input<string> id, ParameterGroupState? state, CustomResourceOptions? opts = null)public static ParameterGroup get(String name, Output<String> id, ParameterGroupState state, CustomResourceOptions options)resources: _: type: alicloud:polardb:ParameterGroup get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string - 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.
- Db
Type string - The type of the database engine. Only
MySQLis supported. - Db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- Description string
- The description of the parameter template.
- Name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- Parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Parameter Group Parameter> Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- Create
Time string - 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.
- Db
Type string - The type of the database engine. Only
MySQLis supported. - Db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- Description string
- The description of the parameter template.
- Name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- Parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- Parameters
[]Parameter
Group Parameter Args Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- create
Time String - 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.
- db
Type String - The type of the database engine. Only
MySQLis supported. - db
Version String - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- description String
- The description of the parameter template.
- name String
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group StringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- parameters
List<Parameter
Group Parameter> Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- create
Time string - 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.
- db
Type string - The type of the database engine. Only
MySQLis supported. - db
Version string - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- description string
- The description of the parameter template.
- name string
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group stringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- parameters
Parameter
Group Parameter[] Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- create_
time str - 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.
- db_
type str - The type of the database engine. Only
MySQLis supported. - db_
version str - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- description str
- The description of the parameter template.
- name str
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter_
group_ strname The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- parameters
Sequence[Parameter
Group Parameter Args] Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
- create
Time String - 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.
- db
Type String - The type of the database engine. Only
MySQLis supported. - db
Version String - The version of the database engine. Valid values:
- 5.6
- 5.7
- 8.0
- description String
- The description of the parameter template.
- name String
- . Field 'name' has been deprecated from provider version 1.263.0. New field 'parameter_group_name' instead.
- parameter
Group StringName The name of the parameter template. The name must meet the following requirements:
It must start with a letter and can contain letters, digits, and underscores (). It cannot contain Chinese characters or end with an underscore ().
It must be 8 to 64 characters in length.
- parameters List<Property Map>
Details about the parameters. See
parametersbelow.NOTE: You can view all parameter details for the target database engine version database cluster through the DescribeParameterTemplates, including parameter name, value.
The following arguments will be discarded. Please use new fields as soon as possible:
Supporting Types
ParameterGroupParameter, ParameterGroupParameterArgs
- Param
Name string - The name of the parameter.
- Param
Value string - The value of the parameter.
- Param
Name string - The name of the parameter.
- Param
Value string - The value of the parameter.
- param
Name String - The name of the parameter.
- param
Value String - The value of the parameter.
- param
Name string - The name of the parameter.
- param
Value string - The value of the parameter.
- param_
name str - The name of the parameter.
- param_
value str - The value of the parameter.
- param
Name String - The name of the parameter.
- param
Value String - The value of the parameter.
Import
Polar Db Parameter Group can be imported using the id, e.g.
$ pulumi import alicloud:polardb/parameterGroup:ParameterGroup example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.
