@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
119 lines (118 loc) • 5.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage redis parameter group
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.redis.ParameterGroup("foo", {
* description: "tf-test-description",
* engineVersion: "5.0",
* paramValues: [
* {
* name: "active-defrag-cycle-max",
* value: "30",
* },
* {
* name: "active-defrag-cycle-min",
* value: "15",
* },
* ],
* });
* ```
*
* ## Import
*
* ParameterGroup can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:redis/parameterGroup:ParameterGroup default resource_id
* ```
*/
export declare class ParameterGroup extends pulumi.CustomResource {
/**
* Get an existing ParameterGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState, opts?: pulumi.CustomResourceOptions): ParameterGroup;
/**
* Returns true if the given object is an instance of ParameterGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ParameterGroup;
/**
* The remarks information of the parameter template should not exceed 200 characters in length.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
*/
readonly engineVersion: pulumi.Output<string>;
/**
* Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
*/
readonly name: pulumi.Output<string>;
/**
* The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly paramValues: pulumi.Output<outputs.redis.ParameterGroupParamValue[]>;
/**
* Create a ParameterGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ParameterGroup resources.
*/
export interface ParameterGroupState {
/**
* The remarks information of the parameter template should not exceed 200 characters in length.
*/
description?: pulumi.Input<string>;
/**
* The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
*/
engineVersion?: pulumi.Input<string>;
/**
* Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
*/
name?: pulumi.Input<string>;
/**
* The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
paramValues?: pulumi.Input<pulumi.Input<inputs.redis.ParameterGroupParamValue>[]>;
}
/**
* The set of arguments for constructing a ParameterGroup resource.
*/
export interface ParameterGroupArgs {
/**
* The remarks information of the parameter template should not exceed 200 characters in length.
*/
description?: pulumi.Input<string>;
/**
* The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
*/
engineVersion: pulumi.Input<string>;
/**
* Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
*/
name?: pulumi.Input<string>;
/**
* The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
paramValues: pulumi.Input<pulumi.Input<inputs.redis.ParameterGroupParamValue>[]>;
}