Package com.pulumi.aws.rds

Class OptionGroup

  • public class OptionGroup
extends com.pulumi.resources.CustomResource
    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 
     
 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 com.pulumi.aws.rds.inputs.OptionGroupOptionOptionSettingArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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()
             .options(            
                 OptionGroupOptionArgs.builder()
                     .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
                         .name("TIME_ZONE")
                         .value("UTC")
                         .build())
                     .optionName("Timezone")
                     .build(),
                 OptionGroupOptionArgs.builder()
                     .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
                         .name("IAM_ROLE_ARN")
                         .value(exampleAwsIamRole.arn())
                         .build())
                     .optionName("SQLSERVER_BACKUP_RESTORE")
                     .build(),
                 OptionGroupOptionArgs.builder()
                     .optionName("TDE")
                     .build())
             .name("option-group-test")
             .optionGroupDescription("Option Group")
             .engineName("sqlserver-ee")
             .majorEngineVersion("11.00")
             .build());
 
     }
 }
    > **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 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> engineName()  
      static OptionGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OptionGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> majorEngineVersion()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> namePrefix()  
      com.pulumi.core.Output<java.lang.String> optionGroupDescription()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<OptionGroupOption>>> options()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipDestroy()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OptionGroup

        public OptionGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • OptionGroup

        public OptionGroup​(java.lang.String name,
                   OptionGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • OptionGroup

        public OptionGroup​(java.lang.String name,
                   OptionGroupArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the DB option group.

      • engineName

        public com.pulumi.core.Output<java.lang.String> engineName()
        Returns:
        Name of the engine that this option group should be associated with.

      • majorEngineVersion

        public com.pulumi.core.Output<java.lang.String> majorEngineVersion()
        Returns:
        Major version of the engine that this option group should be associated with.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        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.

      • namePrefix

        public com.pulumi.core.Output<java.lang.String> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.

      • optionGroupDescription

        public com.pulumi.core.Output<java.lang.String> optionGroupDescription()
        Returns:
        Description of the option group. Defaults to "Managed by Pulumi".

      • options

        public com.pulumi.core.Output<java.util.Optional<java.util.List<OptionGroupOption>>> options()
        Returns:
        Options to apply. See `option` Block below for more details.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • skipDestroy

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipDestroy()
        Returns:
        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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static OptionGroup get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              OptionGroupState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.