Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. OptionGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.OptionGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

    Create OptionGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OptionGroup(name: string, args: OptionGroupArgs, opts?: CustomResourceOptions);
    @overload
def OptionGroup(resource_name: str,
                args: OptionGroupArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OptionGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                engine_name: Optional[str] = None,
                major_engine_version: Optional[str] = None,
                option_group_description: Optional[str] = None,
                option_configurations: Optional[Sequence[OptionGroupOptionConfigurationArgs]] = None,
                option_group_name: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewOptionGroup(ctx *Context, name string, args OptionGroupArgs, opts ...ResourceOption) (*OptionGroup, error)
    public OptionGroup(string name, OptionGroupArgs args, CustomResourceOptions? opts = null)
    public OptionGroup(String name, OptionGroupArgs args)
public OptionGroup(String name, OptionGroupArgs args, CustomResourceOptions options)

    type: aws-native:rds:OptionGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OptionGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OptionGroup resource accepts the following input properties:

    EngineName 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
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    OptionGroupDescription string
    The description of the option group.
    OptionConfigurations List<Pulumi.AwsNative.Rds.Inputs.OptionGroupOptionConfiguration>
    A list of all available options for an option group.
    OptionGroupName string

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags to assign to the option group.
    EngineName 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
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    OptionGroupDescription string
    The description of the option group.
    OptionConfigurations []OptionGroupOptionConfigurationArgs
    A list of all available options for an option group.
    OptionGroupName string

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    Tags TagArgs
    Tags to assign to the option group.
    engineName 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
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    optionGroupDescription String
    The description of the option group.
    optionConfigurations List<OptionGroupOptionConfiguration>
    A list of all available options for an option group.
    optionGroupName String

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    tags List<Tag>
    Tags to assign to the option group.
    engineName 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
    majorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    optionGroupDescription string
    The description of the option group.
    optionConfigurations OptionGroupOptionConfiguration[]
    A list of all available options for an option group.
    optionGroupName string

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    tags Tag[]
    Tags to assign to the option group.
    engine_name str
    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 str
    Specifies the major version of the engine that this option group should be associated with.
    option_group_description str
    The description of the option group.
    option_configurations Sequence[OptionGroupOptionConfigurationArgs]
    A list of all available options for an option group.
    option_group_name str

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    tags Sequence[TagArgs]
    Tags to assign to the option group.
    engineName 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
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    optionGroupDescription String
    The description of the option group.
    optionConfigurations List<Property Map>
    A list of all available options for an option group.
    optionGroupName String

    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 If you don't specify a value for OptionGroupName property, a name is automatically created for the option group. This value is stored as a lowercase string.

    tags List<Property Map>
    Tags to assign to the option group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OptionGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    OptionGroupOptionConfiguration, OptionGroupOptionConfigurationArgs

    OptionName string
    The configuration of options to include in a group.
    DbSecurityGroupMemberships List<string>
    A list of DB security groups used for this option.
    OptionSettings List<Pulumi.AwsNative.Rds.Inputs.OptionGroupOptionSetting>
    The option settings to include in an option group.
    OptionVersion string
    The version for the option.
    Port int
    The optional port for the option.
    VpcSecurityGroupMemberships List<string>
    A list of VPC security group names used for this option.
    OptionName string
    The configuration of options to include in a group.
    DbSecurityGroupMemberships []string
    A list of DB security groups used for this option.
    OptionSettings []OptionGroupOptionSetting
    The option settings to include in an option group.
    OptionVersion string
    The version for the option.
    Port int
    The optional port for the option.
    VpcSecurityGroupMemberships []string
    A list of VPC security group names used for this option.
    optionName String
    The configuration of options to include in a group.
    dbSecurityGroupMemberships List<String>
    A list of DB security groups used for this option.
    optionSettings List<OptionGroupOptionSetting>
    The option settings to include in an option group.
    optionVersion String
    The version for the option.
    port Integer
    The optional port for the option.
    vpcSecurityGroupMemberships List<String>
    A list of VPC security group names used for this option.
    optionName string
    The configuration of options to include in a group.
    dbSecurityGroupMemberships string[]
    A list of DB security groups used for this option.
    optionSettings OptionGroupOptionSetting[]
    The option settings to include in an option group.
    optionVersion string
    The version for the option.
    port number
    The optional port for the option.
    vpcSecurityGroupMemberships string[]
    A list of VPC security group names used for this option.
    option_name str
    The configuration of options to include in a group.
    db_security_group_memberships Sequence[str]
    A list of DB security groups used for this option.
    option_settings Sequence[OptionGroupOptionSetting]
    The option settings to include in an option group.
    option_version str
    The version for the option.
    port int
    The optional port for the option.
    vpc_security_group_memberships Sequence[str]
    A list of VPC security group names used for this option.
    optionName String
    The configuration of options to include in a group.
    dbSecurityGroupMemberships List<String>
    A list of DB security groups used for this option.
    optionSettings List<Property Map>
    The option settings to include in an option group.
    optionVersion String
    The version for the option.
    port Number
    The optional port for the option.
    vpcSecurityGroupMemberships List<String>
    A list of VPC security group names used for this option.

    OptionGroupOptionSetting, OptionGroupOptionSettingArgs

    Name string
    The name of the option that has settings that you can set.
    Value string
    The current value of the option setting.
    Name string
    The name of the option that has settings that you can set.
    Value string
    The current value of the option setting.
    name String
    The name of the option that has settings that you can set.
    value String
    The current value of the option setting.
    name string
    The name of the option that has settings that you can set.
    value string
    The current value of the option setting.
    name str
    The name of the option that has settings that you can set.
    value str
    The current value of the option setting.
    name String
    The name of the option that has settings that you can set.
    value String
    The current value of the option setting.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native