docdb_create_db_cluster_parameter_group: Creates a new cluster parameter group

Description Usage Arguments Value Request syntax

View source: R/docdb_operations.R

Description

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

Usage

1
2
docdb_create_db_cluster_parameter_group(DBClusterParameterGroupName,
  DBParameterGroupFamily, Description, Tags)

Arguments

DBClusterParameterGroupName

[required] The name of the cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

DBParameterGroupFamily

[required] The cluster parameter group family name.

Description

[required] The description for the cluster parameter group.

Tags

The tags to be assigned to the cluster parameter group.

Value

A list with the following syntax:

1
2
3
4
5
6
7
8
list(
  DBClusterParameterGroup = list(
    DBClusterParameterGroupName = "string",
    DBParameterGroupFamily = "string",
    Description = "string",
    DBClusterParameterGroupArn = "string"
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$create_db_cluster_parameter_group(
  DBClusterParameterGroupName = "string",
  DBParameterGroupFamily = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.database documentation built on March 9, 2021, 5:11 p.m.