Class: Aws::RDS::Types::CreateDBParameterGroupMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass CreateDBParameterGroupMessage data as a hash:

{
  db_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

Instance Attribute Details

#db_parameter_group_familyString

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

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 MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

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

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Returns:

  • (String)


4922
4923
4924
4925
4926
4927
4928
4929
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4922

class CreateDBParameterGroupMessage < Struct.new(
  :db_parameter_group_name,
  :db_parameter_group_family,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_nameString

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

Returns:

  • (String)


4922
4923
4924
4925
4926
4927
4928
4929
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4922

class CreateDBParameterGroupMessage < Struct.new(
  :db_parameter_group_name,
  :db_parameter_group_family,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the DB parameter group.

Returns:

  • (String)


4922
4923
4924
4925
4926
4927
4928
4929
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4922

class CreateDBParameterGroupMessage < Struct.new(
  :db_parameter_group_name,
  :db_parameter_group_family,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to assign to the DB parameter group.

Returns:



4922
4923
4924
4925
4926
4927
4928
4929
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4922

class CreateDBParameterGroupMessage < Struct.new(
  :db_parameter_group_name,
  :db_parameter_group_family,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end