Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. DbParameterGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbParameterGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Create DbParameterGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbParameterGroup(name: string, args: DbParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
def DbParameterGroup(resource_name: str,
                     args: DbParameterGroupArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def DbParameterGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     family: Optional[str] = None,
                     db_parameter_group_name: Optional[str] = None,
                     parameters: Optional[Any] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDbParameterGroup(ctx *Context, name string, args DbParameterGroupArgs, opts ...ResourceOption) (*DbParameterGroup, error)
    public DbParameterGroup(string name, DbParameterGroupArgs args, CustomResourceOptions? opts = null)
    public DbParameterGroup(String name, DbParameterGroupArgs args)
public DbParameterGroup(String name, DbParameterGroupArgs args, CustomResourceOptions options)

    type: aws-native:rds:DbParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DbParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbParameterGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbParameterGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DbParameterGroup resource accepts the following input properties:

    Description string
    Provides the customer-specified description for this DB parameter group.
    Family string
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    Parameters object

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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.Inputs.Tag>
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
    Description string
    Provides the customer-specified description for this DB parameter group.
    Family string
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    Parameters interface{}

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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 TagArgs
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
    description String
    Provides the customer-specified description for this DB parameter group.
    family String
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    parameters Object

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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>
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
    description string
    Provides the customer-specified description for this DB parameter group.
    family string
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    parameters any

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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 Tag[]
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
    description str
    Provides the customer-specified description for this DB parameter group.
    family str
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    parameters Any

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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[TagArgs]
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
    description String
    Provides the customer-specified description for this DB parameter group.
    family String
    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see CreateDBParameterGroup.
    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.

    parameters Any

    An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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>
    An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbParameterGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native