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

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.rds.DbClusterParameterGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide. If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.

    Create DbClusterParameterGroup Resource

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

    Constructor syntax

    new DbClusterParameterGroup(name: string, args: DbClusterParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DbClusterParameterGroup(resource_name: str,
                                args: DbClusterParameterGroupArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbClusterParameterGroup(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                description: Optional[str] = None,
                                family: Optional[str] = None,
                                parameters: Optional[Any] = None,
                                db_cluster_parameter_group_name: Optional[str] = None,
                                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDbClusterParameterGroup(ctx *Context, name string, args DbClusterParameterGroupArgs, opts ...ResourceOption) (*DbClusterParameterGroup, error)
    public DbClusterParameterGroup(string name, DbClusterParameterGroupArgs args, CustomResourceOptions? opts = null)
    public DbClusterParameterGroup(String name, DbClusterParameterGroupArgs args)
    public DbClusterParameterGroup(String name, DbClusterParameterGroupArgs args, CustomResourceOptions options)
    
    type: aws-native:rds:DbClusterParameterGroup
    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 DbClusterParameterGroupArgs
    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 DbClusterParameterGroupArgs
    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 DbClusterParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbClusterParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbClusterParameterGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbClusterParameterGroup 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 DbClusterParameterGroup resource accepts the following input properties:

    Description string
    A friendly description for this DB cluster parameter group.
    Family string
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    Parameters object

    Provides a list of parameters for the DB cluster parameter group.

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

    DbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    Description string
    A friendly description for this DB cluster parameter group.
    Family string
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    Parameters interface{}

    Provides a list of parameters for the DB cluster parameter group.

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

    DbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    Tags TagArgs
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    description String
    A friendly description for this DB cluster parameter group.
    family String
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    parameters Object

    Provides a list of parameters for the DB cluster parameter group.

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

    dbClusterParameterGroupName String

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    tags List<Tag>
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    description string
    A friendly description for this DB cluster parameter group.
    family string
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    parameters any

    Provides a list of parameters for the DB cluster parameter group.

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

    dbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    tags Tag[]
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    description str
    A friendly description for this DB cluster parameter group.
    family str
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    parameters Any

    Provides a list of parameters for the DB cluster parameter group.

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

    db_cluster_parameter_group_name str

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    tags Sequence[TagArgs]
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    description String
    A friendly description for this DB cluster parameter group.
    family String
    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup.
    parameters Any

    Provides a list of parameters for the DB cluster parameter group.

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

    dbClusterParameterGroupName String

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

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

    tags List<Property Map>
    An optional array of key-value pairs to apply to this DB cluster parameter group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbClusterParameterGroup 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.111.0 published on Tuesday, Jul 9, 2024 by Pulumi