libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.CreateDBParameterGroup

Description

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the /Parameter Groups/ option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Synopsis

Creating a Request

data CreateDBParameterGroup Source #

See: newCreateDBParameterGroup smart constructor.

Constructors

CreateDBParameterGroup' 

Fields

  • tags :: Maybe [Tag]

    Tags to assign to the DB parameter group.

  • dbParameterGroupName :: Text

    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.

  • dbParameterGroupFamily :: Text

    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 Aurora)
    • aurora-postgresql
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
  • description :: Text

    The description for the DB parameter group.

Instances

Instances details
Eq CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Read CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Show CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Generic CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Associated Types

type Rep CreateDBParameterGroup :: Type -> Type #

NFData CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Methods

rnf :: CreateDBParameterGroup -> () #

Hashable CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

AWSRequest CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Associated Types

type AWSResponse CreateDBParameterGroup #

ToHeaders CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

ToPath CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

ToQuery CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

type Rep CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

type Rep CreateDBParameterGroup = D1 ('MetaData "CreateDBParameterGroup" "Amazonka.RDS.CreateDBParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

newCreateDBParameterGroup Source #

Create a value of CreateDBParameterGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:CreateDBParameterGroup', createDBParameterGroup_tags - Tags to assign to the DB parameter group.

$sel:dbParameterGroupName:CreateDBParameterGroup', createDBParameterGroup_dbParameterGroupName - 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.

$sel:dbParameterGroupFamily:CreateDBParameterGroup', createDBParameterGroup_dbParameterGroupFamily - 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 Aurora)
  • aurora-postgresql
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

$sel:description:CreateDBParameterGroup', createDBParameterGroup_description - The description for the DB parameter group.

Request Lenses

createDBParameterGroup_tags :: Lens' CreateDBParameterGroup (Maybe [Tag]) Source #

Tags to assign to the DB parameter group.

createDBParameterGroup_dbParameterGroupName :: Lens' CreateDBParameterGroup Text Source #

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.

createDBParameterGroup_dbParameterGroupFamily :: Lens' CreateDBParameterGroup Text Source #

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 Aurora)
  • aurora-postgresql
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

createDBParameterGroup_description :: Lens' CreateDBParameterGroup Text Source #

The description for the DB parameter group.

Destructuring the Response

data CreateDBParameterGroupResponse Source #

See: newCreateDBParameterGroupResponse smart constructor.

Constructors

CreateDBParameterGroupResponse' 

Fields

Instances

Instances details
Eq CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Read CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Show CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Generic CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

Associated Types

type Rep CreateDBParameterGroupResponse :: Type -> Type #

NFData CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

type Rep CreateDBParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBParameterGroup

type Rep CreateDBParameterGroupResponse = D1 ('MetaData "CreateDBParameterGroupResponse" "Amazonka.RDS.CreateDBParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBParameterGroupResponse Source #

Create a value of CreateDBParameterGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbParameterGroup:CreateDBParameterGroupResponse', createDBParameterGroupResponse_dbParameterGroup - Undocumented member.

$sel:httpStatus:CreateDBParameterGroupResponse', createDBParameterGroupResponse_httpStatus - The response's http status code.

Response Lenses