Package com.pulumi.aws.rds

Class ParameterGroup

  • public class ParameterGroup
extends com.pulumi.resources.CustomResource
    Provides an RDS DB parameter group resource. Documentation of the available parameters for various RDS 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) * [MariaDB Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Parameters.html) * [Oracle Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.Oracle.html#USER_ModifyInstance.Oracle.sqlnet) * [PostgreSQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#Appendix.PostgreSQL.CommonDBATasks.Parameters) > **Hands-on:** For an example of the `aws.rds.ParameterGroup` in use, follow the Manage AWS RDS Instances tutorial on HashiCorp Learn. > **NOTE**: to make diffs less confusing, the AWS provider will ignore changes for a `parameter` whose `value` remains unchanged but whose `apply_method` is changing (e.g., from `immediate` to `pending-reboot`, or `pending-reboot` to `immediate`). This matches the cloud: if only the apply method of a parameter is changing, the AWS API will not register this change. To change the `apply_method` of a parameter, its value must also change. ## Example Usage ### Basic Usage <!--Start PulumiCodeChooser --> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.rds.ParameterGroup; import com.pulumi.aws.rds.ParameterGroupArgs; import com.pulumi.aws.rds.inputs.ParameterGroupParameterArgs; 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 default_ = new ParameterGroup("default", ParameterGroupArgs.builder() .name("rds-pg") .family("mysql5.6") .parameters( ParameterGroupParameterArgs.builder() .name("character_set_server") .value("utf8") .build(), ParameterGroupParameterArgs.builder() .name("character_set_client") .value("utf8") .build()) .build()); } } ``` <!--End PulumiCodeChooser --> ### `create_before_destroy` Lifecycle Configuration The `create_before_destroy` lifecycle configuration is necessary for modifications that force re-creation of an existing, in-use parameter group. This includes common situations like changing the group `name` or bumping the `family` version during a major version upgrade. This configuration will prevent destruction of the deposed parameter group while still in use by the database during upgrade. <!--Start PulumiCodeChooser --> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.rds.ParameterGroup; import com.pulumi.aws.rds.ParameterGroupArgs; import com.pulumi.aws.rds.inputs.ParameterGroupParameterArgs; import com.pulumi.aws.rds.Instance; import com.pulumi.aws.rds.InstanceArgs; 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 ParameterGroup("example", ParameterGroupArgs.builder() .name("my-pg") .family("postgres13") .parameters(ParameterGroupParameterArgs.builder() .name("log_connections") .value("1") .build()) .build()); var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder() .parameterGroupName(example.name()) .applyImmediately(true) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import DB Parameter groups using the `name`. For example: ```sh $ pulumi import aws:rds/parameterGroup:ParameterGroup rds_pg rds-pg ```

    • 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> description()  
      com.pulumi.core.Output<java.lang.String> family()  
      static ParameterGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ParameterGroupState 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> name()  
      com.pulumi.core.Output<java.lang.String> namePrefix()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ParameterGroupParameter>>> parameters()  
      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

      • ParameterGroup

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

      • ParameterGroup

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

      • ParameterGroup

        public ParameterGroup​(java.lang.String name,
                      ParameterGroupArgs 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:
        The ARN of the db parameter group.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        The description of the DB parameter group. Defaults to "Managed by Pulumi".

      • family

        public com.pulumi.core.Output<java.lang.String> family()
        Returns:
        The family of the DB parameter group.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the DB parameter group. If omitted, this provider will assign a random, unique name.

      • namePrefix

        public com.pulumi.core.Output<java.lang.String> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • parameters

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ParameterGroupParameter>>> parameters()
        Returns:
        The DB parameters to apply. See `parameter` Block below for more details. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via [`aws rds describe-db-parameters`](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html) after initial creation of the group.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A 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.

      • tagsAll

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

      • get

        public static ParameterGroup get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 ParameterGroupState 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.