@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
134 lines • 6.07 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.OptionGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at:
*
* * [MariaDB Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Options.html)
* * [Microsoft SQL Server Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.html)
* * [MySQL Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.Options.html)
* * [Oracle Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.html)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.rds.OptionGroup("example", {
* name: "option-group-test",
* optionGroupDescription: "Option Group",
* engineName: "sqlserver-ee",
* majorEngineVersion: "11.00",
* options: [
* {
* optionName: "Timezone",
* optionSettings: [{
* name: "TIME_ZONE",
* value: "UTC",
* }],
* },
* {
* optionName: "SQLSERVER_BACKUP_RESTORE",
* optionSettings: [{
* name: "IAM_ROLE_ARN",
* value: exampleAwsIamRole.arn,
* }],
* },
* {
* optionName: "TDE",
* },
* ],
* });
* ```
*
* > **Note:** Any modifications to the `aws.rds.OptionGroup` are set to happen immediately as we default to applying immediately.
*
* > **WARNING:** You can perform a destroy on a `aws.rds.OptionGroup`, as long as it is not associated with any Amazon RDS resource. An option group can be associated with a DB instance, a manual DB snapshot, or an automated DB snapshot.
*
* If you try to delete an option group that is associated with an Amazon RDS resource, an error similar to the following is returned:
*
* > An error occurred (InvalidOptionGroupStateFault) when calling the DeleteOptionGroup operation: The option group 'optionGroupName' cannot be deleted because it is in use.
*
* More information about this can be found [here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Delete).
*
* ## Import
*
* Using `pulumi import`, import DB option groups using the `name`. For example:
*
* ```sh
* $ pulumi import aws:rds/optionGroup:OptionGroup example mysql-option-group
* ```
*/
class OptionGroup extends pulumi.CustomResource {
/**
* Get an existing OptionGroup 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 OptionGroup(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of OptionGroup. 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'] === OptionGroup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["engineName"] = state?.engineName;
resourceInputs["majorEngineVersion"] = state?.majorEngineVersion;
resourceInputs["name"] = state?.name;
resourceInputs["namePrefix"] = state?.namePrefix;
resourceInputs["optionGroupDescription"] = state?.optionGroupDescription;
resourceInputs["options"] = state?.options;
resourceInputs["region"] = state?.region;
resourceInputs["skipDestroy"] = state?.skipDestroy;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.engineName === undefined && !opts.urn) {
throw new Error("Missing required property 'engineName'");
}
if (args?.majorEngineVersion === undefined && !opts.urn) {
throw new Error("Missing required property 'majorEngineVersion'");
}
resourceInputs["engineName"] = args?.engineName;
resourceInputs["majorEngineVersion"] = args?.majorEngineVersion;
resourceInputs["name"] = args?.name;
resourceInputs["namePrefix"] = args?.namePrefix;
resourceInputs["optionGroupDescription"] = (args?.optionGroupDescription) ?? "Managed by Pulumi";
resourceInputs["options"] = args?.options;
resourceInputs["region"] = args?.region;
resourceInputs["skipDestroy"] = args?.skipDestroy;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(OptionGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.OptionGroup = OptionGroup;
/** @internal */
OptionGroup.__pulumiType = 'aws:rds/optionGroup:OptionGroup';
//# sourceMappingURL=optionGroup.js.map