Creates a new option group. You can create up to 20 option groups.
This command doesn’t apply to RDS Custom.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
create-option-group
--option-group-name <value>
--engine-name <value>
--major-engine-version <value>
--option-group-description <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--option-group-name
(string)
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
--engine-name
(string)
Specifies the name of the engine that this option group should be associated with.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
--major-engine-version
(string)
Specifies the major version of the engine that this option group should be associated with.
--option-group-description
(string)
The description of the option group.
--tags
(list)
Tags to assign to the option group.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To Create an Amazon RDS option group
The following create-option-group
command creates a new Amazon RDS option group for Oracle Enterprise Edition
version 11.2`, is named ``MyOptionGroup
and includes a description.
aws rds create-option-group \
--option-group-name MyOptionGroup \
--engine-name oracle-ee \
--major-engine-version 11.2 \
--option-group-description "Oracle Database Manager Database Control"
Output:
{
"OptionGroup": {
"OptionGroupName": "myoptiongroup",
"OptionGroupDescription": "Oracle Database Manager Database Control",
"EngineName": "oracle-ee",
"MajorEngineVersion": "11.2",
"Options": [],
"AllowsVpcAndNonVpcInstanceMemberships": true,
"OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup"
}
}
OptionGroup -> (structure)
OptionGroupName -> (string)
Specifies the name of the option group.
OptionGroupDescription -> (string)
Provides a description of the option group.
EngineName -> (string)
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion -> (string)
Indicates the major engine version associated with this option group.
Options -> (list)
Indicates what options are available in the option group.
(structure)
Option details.
OptionName -> (string)
The name of the option.
OptionDescription -> (string)
The description of the option.
Persistent -> (boolean)
Indicate if this option is persistent.
Permanent -> (boolean)
Indicate if this option is permanent.
Port -> (integer)
If required, the port configured for this option to use.
OptionVersion -> (string)
The version of the option.
OptionSettings -> (list)
The option settings for this option.
(structure)
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name -> (string)
The name of the option that has settings that you can set.
Value -> (string)
The current value of the option setting.
DefaultValue -> (string)
The default value of the option setting.
Description -> (string)
The description of the option setting.
ApplyType -> (string)
The DB engine specific parameter type.
DataType -> (string)
The data type of the option setting.
AllowedValues -> (string)
The allowed values of the option setting.
IsModifiable -> (boolean)
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection -> (boolean)
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships -> (list)
If the option requires access to a port, then this DB security group allows access to the port.
(structure)
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
DBSecurityGroupName -> (string)
The name of the DB security group.
Status -> (string)
The status of the DB security group.
VpcSecurityGroupMemberships -> (list)
If the option requires access to a port, then this VPC security group allows access to the port.
(structure)
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId -> (string)
The name of the VPC security group.
Status -> (string)
The status of the VPC security group.
AllowsVpcAndNonVpcInstanceMemberships -> (boolean)
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value
true
indicates the option group can be applied to both VPC and non-VPC instances.VpcId -> (string)
If AllowsVpcAndNonVpcInstanceMemberships is
false
, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships istrue
and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.OptionGroupArn -> (string)
The Amazon Resource Name (ARN) for the option group.