We recommend new projects start with resources from the AWS provider.
aws-native.neptune.DbParameterGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS::Neptune::DBParameterGroup creates a new DB parameter group. This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance
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,
parameters: Optional[Any] = None,
name: Optional[str] = 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:neptune: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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbParameterGroup resource accepts the following input properties:
- Description string
- Provides the customer-specified description for this DB parameter group.
- Family string
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - Parameters object
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- Name string
- Provides the name of the DB parameter group.
- List<Pulumi.
Aws Native. Inputs. Tag> - An optional array of key-value pairs to apply to this DB parameter group.
- Description string
- Provides the customer-specified description for this DB parameter group.
- Family string
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - Parameters interface{}
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- Name string
- Provides the name of the DB parameter group.
- Tag
Args - An optional array of key-value pairs to apply to this DB parameter group.
- description String
- Provides the customer-specified description for this DB parameter group.
- family String
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - parameters Object
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- name String
- Provides the name of the DB parameter group.
- List<Tag>
- An optional array of key-value pairs to apply to this DB parameter group.
- description string
- Provides the customer-specified description for this DB parameter group.
- family string
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - parameters any
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- name string
- Provides the name of the DB parameter group.
- Tag[]
- An optional array of key-value pairs to apply to this DB parameter group.
- description str
- Provides the customer-specified description for this DB parameter group.
- family str
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - parameters Any
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- name str
- Provides the name of the DB parameter group.
- Sequence[Tag
Args] - An optional array of key-value pairs to apply to this DB parameter group.
- description String
- Provides the customer-specified description for this DB parameter group.
- family String
- Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher. - parameters Any
The parameters to set for this DB parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
Search the CloudFormation User Guide for
AWS::Neptune::DBParameterGroup
for more information about the expected schema for this property.- name String
- Provides the name of the DB parameter group.
- List<Property Map>
- An optional array of key-value pairs to apply to this DB parameter group.
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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.