We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 14, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 14, 2026 by Pulumi
Resource Type definition for AWS::DocDB::DBClusterParameterGroup
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,
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:docdb:DbClusterParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_docdb_db_cluster_parameter_group" "name" {
# resource properties
}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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbClusterParameterGroup resource accepts the following input properties:
- Description string
- The description for the DB cluster parameter group.
- Family string
- The DB cluster parameter group family name (e.g. docdb5.0).
- Parameters object
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- Name string
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Description string
- The description for the DB cluster parameter group.
- Family string
- The DB cluster parameter group family name (e.g. docdb5.0).
- Parameters interface{}
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- Name string
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- description string
- The description for the DB cluster parameter group.
- family string
- The DB cluster parameter group family name (e.g. docdb5.0).
- parameters any
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- name string
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
- list(object)
- An array of key-value pairs to apply to this resource.
- description String
- The description for the DB cluster parameter group.
- family String
- The DB cluster parameter group family name (e.g. docdb5.0).
- parameters Object
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- name String
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- description string
- The description for the DB cluster parameter group.
- family string
- The DB cluster parameter group family name (e.g. docdb5.0).
- parameters any
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- name string
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
- Tag[]
- An array of key-value pairs to apply to this resource.
- description str
- The description for the DB cluster parameter group.
- family str
- The DB cluster parameter group family name (e.g. docdb5.0).
- parameters Any
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- name str
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- description String
- The description for the DB cluster parameter group.
- family String
- The DB cluster parameter group family name (e.g. docdb5.0).
- parameters Any
An object containing key-value pairs of parameters to set for the DB cluster parameter group.
Search the CloudFormation User Guide for
AWS::DocDB::DBClusterParameterGroupfor more information about the expected schema for this property.- name String
- The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
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 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
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 14, 2026 by Pulumi