AWS Cloud Control v1.28.0, May 19 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.rds.getDbParameterGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

On this page

Request a Change

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 in the Amazon RDS User Guide. For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups 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.

Using getDbParameterGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDbParameterGroup(args: GetDbParameterGroupArgs, opts?: InvokeOptions): Promise<GetDbParameterGroupResult>
function getDbParameterGroupOutput(args: GetDbParameterGroupOutputArgs, opts?: InvokeOptions): Output<GetDbParameterGroupResult>

def get_db_parameter_group(db_parameter_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDbParameterGroupResult
def get_db_parameter_group_output(db_parameter_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDbParameterGroupResult]

func LookupDbParameterGroup(ctx *Context, args *LookupDbParameterGroupArgs, opts ...InvokeOption) (*LookupDbParameterGroupResult, error)
func LookupDbParameterGroupOutput(ctx *Context, args *LookupDbParameterGroupOutputArgs, opts ...InvokeOption) LookupDbParameterGroupResultOutput

> Note: This function is named LookupDbParameterGroup in the Go SDK.

public static class GetDbParameterGroup 
{
    public static Task<GetDbParameterGroupResult> InvokeAsync(GetDbParameterGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDbParameterGroupResult> Invoke(GetDbParameterGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbParameterGroupResult> getDbParameterGroup(GetDbParameterGroupArgs args, InvokeOptions options)
public static Output<GetDbParameterGroupResult> getDbParameterGroup(GetDbParameterGroupArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:rds:getDbParameterGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

DbParameterGroupName string

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

DbParameterGroupName string

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

dbParameterGroupName String

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

dbParameterGroupName string

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

db_parameter_group_name str

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

dbParameterGroupName String

The name of the DB parameter group. Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. This value is stored as a lowercase string.

getDbParameterGroup Result

The following output properties are available:

Parameters object

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

Tags List<Pulumi.AwsNative.Outputs.Tag>

Tags to assign to the DB parameter group.

Parameters interface{}

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

Tags to assign to the DB parameter group.

parameters Object

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

tags List<Tag>

Tags to assign to the DB parameter group.

parameters any

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

Tags to assign to the DB parameter group.

parameters Any

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

tags Sequence[root_Tag]

Tags to assign to the DB parameter group.

parameters Any

A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups in the Amazon Aurora User Guide. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Search the CloudFormation User Guide for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

tags List<Property Map>

Tags to assign to the DB parameter group.

Supporting Types

Tag

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

On this page

Request a Change