Class: Aws::RDS::Types::CreateDBClusterParameterGroupMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::CreateDBClusterParameterGroupMessage
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
When making an API call, you may pass CreateDBClusterParameterGroupMessage data as a hash:
{
db_cluster_parameter_group_name: "String", # required
db_parameter_group_family: "String", # required
description: "String", # required
tags: [
{
key: "String",
value: "String",
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group.
-
#db_parameter_group_family ⇒ String
The DB cluster parameter group family name.
-
#description ⇒ String
The description for the DB cluster parameter group.
-
#tags ⇒ Array<Types::Tag>
Tags to assign to the DB cluster parameter group.
Instance Attribute Details
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group.
Constraints:
- Must not match the name of an existing DB cluster parameter group.
^
2826 2827 2828 2829 2830 2831 2832 2833 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2826 class CreateDBClusterParameterGroupMessage < Struct.new( :db_cluster_parameter_group_name, :db_parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end |
#db_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 database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora5.6
, aurora-mysql5.7
, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql9.6
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine
aurora-postgresql
The following are the valid DB engine values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresql
mysql
postgres
2826 2827 2828 2829 2830 2831 2832 2833 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2826 class CreateDBClusterParameterGroupMessage < Struct.new( :db_cluster_parameter_group_name, :db_parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description for the DB cluster parameter group.
2826 2827 2828 2829 2830 2831 2832 2833 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2826 class CreateDBClusterParameterGroupMessage < Struct.new( :db_cluster_parameter_group_name, :db_parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Tags to assign to the DB cluster parameter group.
2826 2827 2828 2829 2830 2831 2832 2833 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2826 class CreateDBClusterParameterGroupMessage < Struct.new( :db_cluster_parameter_group_name, :db_parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end |