Creates a new option group¶

Description¶

Creates a new option group. You can create up to 20 option groups.

This command doesn't apply to RDS Custom.

Usage¶

rds_create_option_group(OptionGroupName, EngineName, MajorEngineVersion,
  OptionGroupDescription, Tags)

Arguments¶

OptionGroupName

[required] Specifies the name of the option group to be created.

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
Example: myoptiongroup
EngineName

[required] The name of the engine to associate this option group with.

Valid Values:
- db2-ae
- db2-ce
- db2-se
- mariadb
- mysql
- oracle-ee
- oracle-ee-cdb
- oracle-se2
- oracle-se2-cdb
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
MajorEngineVersion

[required] Specifies the major version of the engine that this option group should be associated with.
OptionGroupDescription

[required] The description of the option group.
Tags

Tags to assign to the option group.

Value¶

A list with the following syntax:

list(
  OptionGroup = list(
    OptionGroupName = "string",
    OptionGroupDescription = "string",
    EngineName = "string",
    MajorEngineVersion = "string",
    Options = list(
      list(
        OptionName = "string",
        OptionDescription = "string",
        Persistent = TRUE|FALSE,
        Permanent = TRUE|FALSE,
        Port = 123,
        OptionVersion = "string",
        OptionSettings = list(
          list(
            Name = "string",
            Value = "string",
            DefaultValue = "string",
            Description = "string",
            ApplyType = "string",
            DataType = "string",
            AllowedValues = "string",
            IsModifiable = TRUE|FALSE,
            IsCollection = TRUE|FALSE
          )
        ),
        DBSecurityGroupMemberships = list(
          list(
            DBSecurityGroupName = "string",
            Status = "string"
          )
        ),
        VpcSecurityGroupMemberships = list(
          list(
            VpcSecurityGroupId = "string",
            Status = "string"
          )
        )
      )
    ),
    AllowsVpcAndNonVpcInstanceMemberships = TRUE|FALSE,
    VpcId = "string",
    OptionGroupArn = "string",
    SourceOptionGroup = "string",
    SourceAccountId = "string",
    CopyTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$create_option_group(
  OptionGroupName = "string",
  EngineName = "string",
  MajorEngineVersion = "string",
  OptionGroupDescription = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples¶

# This example creates an option group.
svc$create_option_group(
  EngineName = "MySQL",
  MajorEngineVersion = "5.6",
  OptionGroupDescription = "My MySQL 5.6 option group",
  OptionGroupName = "mymysqloptiongroup"
)