@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
76 lines • 4.09 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.DbParameterGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
* This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
* For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
*/
class DbParameterGroup extends pulumi.CustomResource {
/**
* Get an existing DbParameterGroup 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, opts) {
return new DbParameterGroup(name, undefined, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DbParameterGroup. 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'] === DbParameterGroup.__pulumiType;
}
/**
* Create a DbParameterGroup 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, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
if (args?.description === undefined && !opts.urn) {
throw new Error("Missing required property 'description'");
}
if (args?.family === undefined && !opts.urn) {
throw new Error("Missing required property 'family'");
}
resourceInputs["dbParameterGroupName"] = args?.dbParameterGroupName;
resourceInputs["description"] = args?.description;
resourceInputs["family"] = args?.family;
resourceInputs["parameters"] = args?.parameters;
resourceInputs["tags"] = args?.tags;
}
else {
resourceInputs["dbParameterGroupName"] = undefined /*out*/;
resourceInputs["description"] = undefined /*out*/;
resourceInputs["family"] = undefined /*out*/;
resourceInputs["parameters"] = undefined /*out*/;
resourceInputs["tags"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const replaceOnChanges = { replaceOnChanges: ["dbParameterGroupName", "description", "family"] };
opts = pulumi.mergeOptions(opts, replaceOnChanges);
super(DbParameterGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.DbParameterGroup = DbParameterGroup;
/** @internal */
DbParameterGroup.__pulumiType = 'aws-native:rds:DbParameterGroup';
//# sourceMappingURL=dbParameterGroup.js.map