1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. OptionGroup
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

    Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at:

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Rds.OptionGroup("example", new()
        {
            OptionGroupDescription = "Option Group",
            EngineName = "sqlserver-ee",
            MajorEngineVersion = "11.00",
            Options = new[]
            {
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "Timezone",
                    OptionSettings = new[]
                    {
                        new Aws.Rds.Inputs.OptionGroupOptionOptionSettingArgs
                        {
                            Name = "TIME_ZONE",
                            Value = "UTC",
                        },
                    },
                },
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "SQLSERVER_BACKUP_RESTORE",
                    OptionSettings = new[]
                    {
                        new Aws.Rds.Inputs.OptionGroupOptionOptionSettingArgs
                        {
                            Name = "IAM_ROLE_ARN",
                            Value = aws_iam_role.Example.Arn,
                        },
                    },
                },
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "TDE",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rds.NewOptionGroup(ctx, "example", &rds.OptionGroupArgs{
    			OptionGroupDescription: pulumi.String("Option Group"),
    			EngineName:             pulumi.String("sqlserver-ee"),
    			MajorEngineVersion:     pulumi.String("11.00"),
    			Options: rds.OptionGroupOptionArray{
    				&rds.OptionGroupOptionArgs{
    					OptionName: pulumi.String("Timezone"),
    					OptionSettings: rds.OptionGroupOptionOptionSettingArray{
    						&rds.OptionGroupOptionOptionSettingArgs{
    							Name:  pulumi.String("TIME_ZONE"),
    							Value: pulumi.String("UTC"),
    						},
    					},
    				},
    				&rds.OptionGroupOptionArgs{
    					OptionName: pulumi.String("SQLSERVER_BACKUP_RESTORE"),
    					OptionSettings: rds.OptionGroupOptionOptionSettingArray{
    						&rds.OptionGroupOptionOptionSettingArgs{
    							Name:  pulumi.String("IAM_ROLE_ARN"),
    							Value: pulumi.Any(aws_iam_role.Example.Arn),
    						},
    					},
    				},
    				&rds.OptionGroupOptionArgs{
    					OptionName: pulumi.String("TDE"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.rds.OptionGroup;
    import com.pulumi.aws.rds.OptionGroupArgs;
    import com.pulumi.aws.rds.inputs.OptionGroupOptionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new OptionGroup("example", OptionGroupArgs.builder()        
                .optionGroupDescription("Option Group")
                .engineName("sqlserver-ee")
                .majorEngineVersion("11.00")
                .options(            
                    OptionGroupOptionArgs.builder()
                        .optionName("Timezone")
                        .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
                            .name("TIME_ZONE")
                            .value("UTC")
                            .build())
                        .build(),
                    OptionGroupOptionArgs.builder()
                        .optionName("SQLSERVER_BACKUP_RESTORE")
                        .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
                            .name("IAM_ROLE_ARN")
                            .value(aws_iam_role.example().arn())
                            .build())
                        .build(),
                    OptionGroupOptionArgs.builder()
                        .optionName("TDE")
                        .build())
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.rds.OptionGroup("example", {
        optionGroupDescription: "Option Group",
        engineName: "sqlserver-ee",
        majorEngineVersion: "11.00",
        options: [
            {
                optionName: "Timezone",
                optionSettings: [{
                    name: "TIME_ZONE",
                    value: "UTC",
                }],
            },
            {
                optionName: "SQLSERVER_BACKUP_RESTORE",
                optionSettings: [{
                    name: "IAM_ROLE_ARN",
                    value: aws_iam_role.example.arn,
                }],
            },
            {
                optionName: "TDE",
            },
        ],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.rds.OptionGroup("example",
        option_group_description="Option Group",
        engine_name="sqlserver-ee",
        major_engine_version="11.00",
        options=[
            aws.rds.OptionGroupOptionArgs(
                option_name="Timezone",
                option_settings=[aws.rds.OptionGroupOptionOptionSettingArgs(
                    name="TIME_ZONE",
                    value="UTC",
                )],
            ),
            aws.rds.OptionGroupOptionArgs(
                option_name="SQLSERVER_BACKUP_RESTORE",
                option_settings=[aws.rds.OptionGroupOptionOptionSettingArgs(
                    name="IAM_ROLE_ARN",
                    value=aws_iam_role["example"]["arn"],
                )],
            ),
            aws.rds.OptionGroupOptionArgs(
                option_name="TDE",
            ),
        ])
    
    resources:
      example:
        type: aws:rds:OptionGroup
        properties:
          optionGroupDescription: Option Group
          engineName: sqlserver-ee
          majorEngineVersion: '11.00'
          options:
            - optionName: Timezone
              optionSettings:
                - name: TIME_ZONE
                  value: UTC
            - optionName: SQLSERVER_BACKUP_RESTORE
              optionSettings:
                - name: IAM_ROLE_ARN
                  value: ${aws_iam_role.example.arn}
            - optionName: TDE
    

    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,
                    name: Optional[str] = None,
                    name_prefix: Optional[str] = None,
                    option_group_description: Optional[str] = None,
                    options: Optional[Sequence[OptionGroupOptionArgs]] = None,
                    tags: Optional[Mapping[str, str]] = 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: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var optionGroupResource = new Aws.Rds.OptionGroup("optionGroupResource", new()
    {
        EngineName = "string",
        MajorEngineVersion = "string",
        Name = "string",
        NamePrefix = "string",
        OptionGroupDescription = "string",
        Options = new[]
        {
            new Aws.Rds.Inputs.OptionGroupOptionArgs
            {
                OptionName = "string",
                DbSecurityGroupMemberships = new[]
                {
                    "string",
                },
                OptionSettings = new[]
                {
                    new Aws.Rds.Inputs.OptionGroupOptionOptionSettingArgs
                    {
                        Name = "string",
                        Value = "string",
                    },
                },
                Port = 0,
                Version = "string",
                VpcSecurityGroupMemberships = new[]
                {
                    "string",
                },
            },
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := rds.NewOptionGroup(ctx, "optionGroupResource", &rds.OptionGroupArgs{
    	EngineName:             pulumi.String("string"),
    	MajorEngineVersion:     pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	NamePrefix:             pulumi.String("string"),
    	OptionGroupDescription: pulumi.String("string"),
    	Options: rds.OptionGroupOptionArray{
    		&rds.OptionGroupOptionArgs{
    			OptionName: pulumi.String("string"),
    			DbSecurityGroupMemberships: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			OptionSettings: rds.OptionGroupOptionOptionSettingArray{
    				&rds.OptionGroupOptionOptionSettingArgs{
    					Name:  pulumi.String("string"),
    					Value: pulumi.String("string"),
    				},
    			},
    			Port:    pulumi.Int(0),
    			Version: pulumi.String("string"),
    			VpcSecurityGroupMemberships: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var optionGroupResource = new OptionGroup("optionGroupResource", OptionGroupArgs.builder()
        .engineName("string")
        .majorEngineVersion("string")
        .name("string")
        .namePrefix("string")
        .optionGroupDescription("string")
        .options(OptionGroupOptionArgs.builder()
            .optionName("string")
            .dbSecurityGroupMemberships("string")
            .optionSettings(OptionGroupOptionOptionSettingArgs.builder()
                .name("string")
                .value("string")
                .build())
            .port(0)
            .version("string")
            .vpcSecurityGroupMemberships("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    option_group_resource = aws.rds.OptionGroup("optionGroupResource",
        engine_name="string",
        major_engine_version="string",
        name="string",
        name_prefix="string",
        option_group_description="string",
        options=[{
            "option_name": "string",
            "db_security_group_memberships": ["string"],
            "option_settings": [{
                "name": "string",
                "value": "string",
            }],
            "port": 0,
            "version": "string",
            "vpc_security_group_memberships": ["string"],
        }],
        tags={
            "string": "string",
        })
    
    const optionGroupResource = new aws.rds.OptionGroup("optionGroupResource", {
        engineName: "string",
        majorEngineVersion: "string",
        name: "string",
        namePrefix: "string",
        optionGroupDescription: "string",
        options: [{
            optionName: "string",
            dbSecurityGroupMemberships: ["string"],
            optionSettings: [{
                name: "string",
                value: "string",
            }],
            port: 0,
            version: "string",
            vpcSecurityGroupMemberships: ["string"],
        }],
        tags: {
            string: "string",
        },
    });
    
    type: aws:rds:OptionGroup
    properties:
        engineName: string
        majorEngineVersion: string
        name: string
        namePrefix: string
        optionGroupDescription: string
        options:
            - dbSecurityGroupMemberships:
                - string
              optionName: string
              optionSettings:
                - name: string
                  value: string
              port: 0
              version: string
              vpcSecurityGroupMemberships:
                - string
        tags:
            string: string
    

    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.
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    Name string
    The Name of the setting.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    OptionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    Options List<OptionGroupOption>
    A list of Options to apply.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    EngineName string
    Specifies the name of the engine that this option group should be associated with.
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    Name string
    The Name of the setting.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    OptionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    Options []OptionGroupOptionArgs
    A list of Options to apply.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineName String
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    name String
    The Name of the setting.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription String
    The description of the option group. Defaults to "Managed by Pulumi".
    options List<OptionGroupOption>
    A list of Options to apply.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineName string
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    name string
    The Name of the setting.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    options OptionGroupOption[]
    A list of Options to apply.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engine_name str
    Specifies the name of the engine that this option group should be associated with.
    major_engine_version str
    Specifies the major version of the engine that this option group should be associated with.
    name str
    The Name of the setting.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    option_group_description str
    The description of the option group. Defaults to "Managed by Pulumi".
    options Sequence[OptionGroupOptionArgs]
    A list of Options to apply.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineName String
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    name String
    The Name of the setting.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription String
    The description of the option group. Defaults to "Managed by Pulumi".
    options List<Property Map>
    A list of Options to apply.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the db option group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    The ARN of the db option group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the db option group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    The ARN of the db option group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    The ARN of the db option group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the db option group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing OptionGroup Resource

    Get an existing OptionGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OptionGroupState, opts?: CustomResourceOptions): OptionGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            engine_name: Optional[str] = None,
            major_engine_version: Optional[str] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            option_group_description: Optional[str] = None,
            options: Optional[Sequence[OptionGroupOptionArgs]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> OptionGroup
    func GetOptionGroup(ctx *Context, name string, id IDInput, state *OptionGroupState, opts ...ResourceOption) (*OptionGroup, error)
    public static OptionGroup Get(string name, Input<string> id, OptionGroupState? state, CustomResourceOptions? opts = null)
    public static OptionGroup get(String name, Output<String> id, OptionGroupState state, CustomResourceOptions options)
    resources:  _:    type: aws:rds:OptionGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the db option group.
    EngineName string
    Specifies the name of the engine that this option group should be associated with.
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    Name string
    The Name of the setting.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    OptionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    Options List<OptionGroupOption>
    A list of Options to apply.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    The ARN of the db option group.
    EngineName string
    Specifies the name of the engine that this option group should be associated with.
    MajorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    Name string
    The Name of the setting.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    OptionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    Options []OptionGroupOptionArgs
    A list of Options to apply.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the db option group.
    engineName String
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    name String
    The Name of the setting.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription String
    The description of the option group. Defaults to "Managed by Pulumi".
    options List<OptionGroupOption>
    A list of Options to apply.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    The ARN of the db option group.
    engineName string
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion string
    Specifies the major version of the engine that this option group should be associated with.
    name string
    The Name of the setting.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription string
    The description of the option group. Defaults to "Managed by Pulumi".
    options OptionGroupOption[]
    A list of Options to apply.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    The ARN of the db option group.
    engine_name str
    Specifies the name of the engine that this option group should be associated with.
    major_engine_version str
    Specifies the major version of the engine that this option group should be associated with.
    name str
    The Name of the setting.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    option_group_description str
    The description of the option group. Defaults to "Managed by Pulumi".
    options Sequence[OptionGroupOptionArgs]
    A list of Options to apply.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the db option group.
    engineName String
    Specifies the name of the engine that this option group should be associated with.
    majorEngineVersion String
    Specifies the major version of the engine that this option group should be associated with.
    name String
    The Name of the setting.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
    optionGroupDescription String
    The description of the option group. Defaults to "Managed by Pulumi".
    options List<Property Map>
    A list of Options to apply.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Supporting Types

    OptionGroupOption, OptionGroupOptionArgs

    OptionName string
    The Name of the Option (e.g., MEMCACHED).
    DbSecurityGroupMemberships List<string>
    A list of DB Security Groups for which the option is enabled.
    OptionSettings List<OptionGroupOptionOptionSetting>
    A list of option settings to apply.
    Port int
    The Port number when connecting to the Option (e.g., 11211).
    Version string
    The version of the option (e.g., 13.1.0.0).
    VpcSecurityGroupMemberships List<string>
    A list of VPC Security Groups for which the option is enabled.
    OptionName string
    The Name of the Option (e.g., MEMCACHED).
    DbSecurityGroupMemberships []string
    A list of DB Security Groups for which the option is enabled.
    OptionSettings []OptionGroupOptionOptionSetting
    A list of option settings to apply.
    Port int
    The Port number when connecting to the Option (e.g., 11211).
    Version string
    The version of the option (e.g., 13.1.0.0).
    VpcSecurityGroupMemberships []string
    A list of VPC Security Groups for which the option is enabled.
    optionName String
    The Name of the Option (e.g., MEMCACHED).
    dbSecurityGroupMemberships List<String>
    A list of DB Security Groups for which the option is enabled.
    optionSettings List<OptionGroupOptionOptionSetting>
    A list of option settings to apply.
    port Integer
    The Port number when connecting to the Option (e.g., 11211).
    version String
    The version of the option (e.g., 13.1.0.0).
    vpcSecurityGroupMemberships List<String>
    A list of VPC Security Groups for which the option is enabled.
    optionName string
    The Name of the Option (e.g., MEMCACHED).
    dbSecurityGroupMemberships string[]
    A list of DB Security Groups for which the option is enabled.
    optionSettings OptionGroupOptionOptionSetting[]
    A list of option settings to apply.
    port number
    The Port number when connecting to the Option (e.g., 11211).
    version string
    The version of the option (e.g., 13.1.0.0).
    vpcSecurityGroupMemberships string[]
    A list of VPC Security Groups for which the option is enabled.
    option_name str
    The Name of the Option (e.g., MEMCACHED).
    db_security_group_memberships Sequence[str]
    A list of DB Security Groups for which the option is enabled.
    option_settings Sequence[OptionGroupOptionOptionSetting]
    A list of option settings to apply.
    port int
    The Port number when connecting to the Option (e.g., 11211).
    version str
    The version of the option (e.g., 13.1.0.0).
    vpc_security_group_memberships Sequence[str]
    A list of VPC Security Groups for which the option is enabled.
    optionName String
    The Name of the Option (e.g., MEMCACHED).
    dbSecurityGroupMemberships List<String>
    A list of DB Security Groups for which the option is enabled.
    optionSettings List<Property Map>
    A list of option settings to apply.
    port Number
    The Port number when connecting to the Option (e.g., 11211).
    version String
    The version of the option (e.g., 13.1.0.0).
    vpcSecurityGroupMemberships List<String>
    A list of VPC Security Groups for which the option is enabled.

    OptionGroupOptionOptionSetting, OptionGroupOptionOptionSettingArgs

    Name string
    The Name of the setting.
    Value string
    The Value of the setting.
    Name string
    The Name of the setting.
    Value string
    The Value of the setting.
    name String
    The Name of the setting.
    value String
    The Value of the setting.
    name string
    The Name of the setting.
    value string
    The Value of the setting.
    name str
    The Name of the setting.
    value str
    The Value of the setting.
    name String
    The Name of the setting.
    value String
    The Value of the setting.

    Import

    DB Option groups can be imported using the name, e.g.,

     $ pulumi import aws:rds/optionGroup:OptionGroup example mysql-option-group
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.