@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
105 lines • 4.37 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ClusterParameterGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at:
*
* * [Aurora MySQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Reference.html)
* * [Aurora PostgreSQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraPostgreSQL.Reference.html)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const _default = new aws.rds.ClusterParameterGroup("default", {
* name: "rds-cluster-pg",
* family: "aurora5.6",
* description: "RDS default cluster parameter group",
* parameters: [
* {
* name: "character_set_server",
* value: "utf8",
* },
* {
* name: "character_set_client",
* value: "utf8",
* },
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import RDS Cluster Parameter Groups using the `name`. For example:
*
* ```sh
* $ pulumi import aws:rds/clusterParameterGroup:ClusterParameterGroup cluster_pg production-pg-1
* ```
*/
class ClusterParameterGroup extends pulumi.CustomResource {
/**
* Get an existing ClusterParameterGroup 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, id, state, opts) {
return new ClusterParameterGroup(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ClusterParameterGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ClusterParameterGroup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["description"] = state?.description;
resourceInputs["family"] = state?.family;
resourceInputs["name"] = state?.name;
resourceInputs["namePrefix"] = state?.namePrefix;
resourceInputs["parameters"] = state?.parameters;
resourceInputs["region"] = state?.region;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.family === undefined && !opts.urn) {
throw new Error("Missing required property 'family'");
}
resourceInputs["description"] = (args?.description) ?? "Managed by Pulumi";
resourceInputs["family"] = args?.family;
resourceInputs["name"] = args?.name;
resourceInputs["namePrefix"] = args?.namePrefix;
resourceInputs["parameters"] = args?.parameters;
resourceInputs["region"] = args?.region;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ClusterParameterGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.ClusterParameterGroup = ClusterParameterGroup;
/** @internal */
ClusterParameterGroup.__pulumiType = 'aws:rds/clusterParameterGroup:ClusterParameterGroup';
//# sourceMappingURL=clusterParameterGroup.js.map