com.pulumi.aws.rds.OptionGroup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.rds;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.rds.OptionGroupArgs;
import com.pulumi.aws.rds.inputs.OptionGroupState;
import com.pulumi.aws.rds.outputs.OptionGroupOption;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* 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
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.rds.OptionGroup;
* import com.pulumi.aws.rds.OptionGroupArgs;
* import com.pulumi.aws.rds.inputs.OptionGroupOptionArgs;
* 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 OptionGroup("example", OptionGroupArgs.builder()
* .name("option-group-test")
* .optionGroupDescription("Option Group")
* .engineName("sqlserver-ee")
* .majorEngineVersion("11.00")
* .options(
* OptionGroupOptionArgs.builder()
* .optionName("Timezone")
* .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
* .name("TIME_ZONE")
* .value("UTC")
* .build())
* .build(),
* OptionGroupOptionArgs.builder()
* .optionName("SQLSERVER_BACKUP_RESTORE")
* .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
* .name("IAM_ROLE_ARN")
* .value(exampleAwsIamRole.arn())
* .build())
* .build(),
* OptionGroupOptionArgs.builder()
* .optionName("TDE")
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* > **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
* ```
*
*/
@ResourceType(type="aws:rds/optionGroup:OptionGroup")
public class OptionGroup extends com.pulumi.resources.CustomResource {
/**
* ARN of the DB option group.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return ARN of the DB option group.
*
*/
public Output arn() {
return this.arn;
}
/**
* Specifies the name of the engine that this option group should be associated with.
*
*/
@Export(name="engineName", refs={String.class}, tree="[0]")
private Output engineName;
/**
* @return Specifies the name of the engine that this option group should be associated with.
*
*/
public Output engineName() {
return this.engineName;
}
/**
* Specifies the major version of the engine that this option group should be associated with.
*
*/
@Export(name="majorEngineVersion", refs={String.class}, tree="[0]")
private Output majorEngineVersion;
/**
* @return Specifies the major version of the engine that this option group should be associated with.
*
*/
public Output majorEngineVersion() {
return this.majorEngineVersion;
}
/**
* Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
*
*/
public Output name() {
return this.name;
}
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.
*
*/
@Export(name="namePrefix", refs={String.class}, tree="[0]")
private Output namePrefix;
/**
* @return Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.
*
*/
public Output namePrefix() {
return this.namePrefix;
}
/**
* Description of the option group. Defaults to "Managed by Pulumi".
*
*/
@Export(name="optionGroupDescription", refs={String.class}, tree="[0]")
private Output optionGroupDescription;
/**
* @return Description of the option group. Defaults to "Managed by Pulumi".
*
*/
public Output optionGroupDescription() {
return this.optionGroupDescription;
}
/**
* The options to apply. See `option` Block below for more details.
*
*/
@Export(name="options", refs={List.class,OptionGroupOption.class}, tree="[0,1]")
private Output> options;
/**
* @return The options to apply. See `option` Block below for more details.
*
*/
public Output>> options() {
return Codegen.optional(this.options);
}
/**
* Set to true if you do not wish the option group to be deleted at destroy time, and instead just remove the option group from the Pulumi state.
*
*/
@Export(name="skipDestroy", refs={Boolean.class}, tree="[0]")
private Output skipDestroy;
/**
* @return Set to true if you do not wish the option group to be deleted at destroy time, and instead just remove the option group from the Pulumi state.
*
*/
public Output> skipDestroy() {
return Codegen.optional(this.skipDestroy);
}
/**
* Map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public OptionGroup(java.lang.String name) {
this(name, OptionGroupArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public OptionGroup(java.lang.String name, OptionGroupArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public OptionGroup(java.lang.String name, OptionGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:rds/optionGroup:OptionGroup", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private OptionGroup(java.lang.String name, Output id, @Nullable OptionGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:rds/optionGroup:OptionGroup", name, state, makeResourceOptions(options, id), false);
}
private static OptionGroupArgs makeArgs(OptionGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? OptionGroupArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host 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
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static OptionGroup get(java.lang.String name, Output id, @Nullable OptionGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new OptionGroup(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy