Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. rds
  5. OptionGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

aws.rds.OptionGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.OptionGroup("example", {
    name: "option-group-test",
    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: exampleAwsIamRole.arn,
            }],
        },
        {
            optionName: "TDE",
        },
    ],
});

    import pulumi
import pulumi_aws as aws

example = aws.rds.OptionGroup("example",
    name="option-group-test",
    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=example_aws_iam_role["arn"],
            )],
        ),
        aws.rds.OptionGroupOptionArgs(
            option_name="TDE",
        ),
    ])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:                   pulumi.String("option-group-test"),
			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(exampleAwsIamRole.Arn),
						},
					},
				},
				&rds.OptionGroupOptionArgs{
					OptionName: pulumi.String("TDE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Name = "option-group-test",
        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 = exampleAwsIamRole.Arn,
                    },
                },
            },
            new Aws.Rds.Inputs.OptionGroupOptionArgs
            {
                OptionName = "TDE",
            },
        },
    });

});

    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()        
            .name("option-group-test")
            .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(exampleAwsIamRole.arn())
                        .build())
                    .build(),
                OptionGroupOptionArgs.builder()
                    .optionName("TDE")
                    .build())
            .build());

    }
}

    resources:
  example:
    type: aws:rds:OptionGroup
    properties:
      name: option-group-test
      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: ${exampleAwsIamRole.arn}
        - optionName: TDE

    Note: Any modifications to the aws.rds.OptionGroup are set to happen immediately as we default to applying immediately.

    WARNING: You can perform a destroy on a aws.rds.OptionGroup, as long as it is not associated with any Amazon RDS resource. An option group can be associated with a DB instance, a manual DB snapshot, or an automated DB snapshot.

    If you try to delete an option group that is associated with an Amazon RDS resource, an error similar to the following is returned:

    An error occurred (InvalidOptionGroupStateFault) when calling the DeleteOptionGroup operation: The option group ‘optionGroupName’ cannot be deleted because it is in use.

    More information about this can be found here.

    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.

    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=[aws.rds.OptionGroupOptionArgs(
        option_name="string",
        db_security_group_memberships=["string"],
        option_settings=[aws.rds.OptionGroupOptionOptionSettingArgs(
            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

    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    Options List<OptionGroupOption>
    The options to apply. See option Block below for more details.
    Tags Dictionary<string, string>
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    Options []OptionGroupOptionArgs
    The options to apply. See option Block below for more details.
    Tags map[string]string
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options List<OptionGroupOption>
    The options to apply. See option Block below for more details.
    tags Map<String,String>
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options OptionGroupOption[]
    The options to apply. See option Block below for more details.
    tags {[key: string]: string}
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options Sequence[OptionGroupOptionArgs]
    The options to apply. See option Block below for more details.
    tags Mapping[str, str]
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options List<Property Map>
    The options to apply. See option Block below for more details.
    tags Map<String>
    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
    ARN of the DB option group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the DB option group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the DB option group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the DB option group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the DB option group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the DB option group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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)
    Resource lookup is not supported in YAML
    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
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    Options List<OptionGroupOption>
    The options to apply. See option Block below for more details.
    Tags Dictionary<string, string>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    Options []OptionGroupOptionArgs
    The options to apply. See option Block below for more details.
    Tags map[string]string
    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
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options List<OptionGroupOption>
    The options to apply. See option Block below for more details.
    tags Map<String,String>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options OptionGroupOption[]
    The options to apply. See option Block below for more details.
    tags {[key: string]: string}
    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}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options Sequence[OptionGroupOptionArgs]
    The options to apply. See option Block below for more details.
    tags Mapping[str, str]
    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]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    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
    Name of the option group. If omitted, the provider will assign a random, unique name. Must be lowercase, to match as it is stored in AWS.
    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
    Description of the option group.
    options List<Property Map>
    The options to apply. See option Block below for more details.
    tags Map<String>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    OptionGroupOption, OptionGroupOptionArgs

    OptionName string
    Name of the option (e.g., MEMCACHED).
    DbSecurityGroupMemberships List<string>
    List of DB Security Groups for which the option is enabled.
    OptionSettings List<OptionGroupOptionOptionSetting>
    The option settings to apply. See option_settings Block below for more details.
    Port int
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    Version string
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    VpcSecurityGroupMemberships List<string>
    List of VPC Security Groups for which the option is enabled.
    OptionName string
    Name of the option (e.g., MEMCACHED).
    DbSecurityGroupMemberships []string
    List of DB Security Groups for which the option is enabled.
    OptionSettings []OptionGroupOptionOptionSetting
    The option settings to apply. See option_settings Block below for more details.
    Port int
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    Version string
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    VpcSecurityGroupMemberships []string
    List of VPC Security Groups for which the option is enabled.
    optionName String
    Name of the option (e.g., MEMCACHED).
    dbSecurityGroupMemberships List<String>
    List of DB Security Groups for which the option is enabled.
    optionSettings List<OptionGroupOptionOptionSetting>
    The option settings to apply. See option_settings Block below for more details.
    port Integer
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    version String
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    vpcSecurityGroupMemberships List<String>
    List of VPC Security Groups for which the option is enabled.
    optionName string
    Name of the option (e.g., MEMCACHED).
    dbSecurityGroupMemberships string[]
    List of DB Security Groups for which the option is enabled.
    optionSettings OptionGroupOptionOptionSetting[]
    The option settings to apply. See option_settings Block below for more details.
    port number
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    version string
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    vpcSecurityGroupMemberships string[]
    List of VPC Security Groups for which the option is enabled.
    option_name str
    Name of the option (e.g., MEMCACHED).
    db_security_group_memberships Sequence[str]
    List of DB Security Groups for which the option is enabled.
    option_settings Sequence[OptionGroupOptionOptionSetting]
    The option settings to apply. See option_settings Block below for more details.
    port int
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    version str
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    vpc_security_group_memberships Sequence[str]
    List of VPC Security Groups for which the option is enabled.
    optionName String
    Name of the option (e.g., MEMCACHED).
    dbSecurityGroupMemberships List<String>
    List of DB Security Groups for which the option is enabled.
    optionSettings List<Property Map>
    The option settings to apply. See option_settings Block below for more details.
    port Number
    Port number when connecting to the option (e.g., 11211). Leaving out or removing port from your configuration does not remove or clear a port from the option in AWS. AWS may assign a default port. Not including port in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any port changes.
    version String
    Version of the option (e.g., 13.1.0.0). Leaving out or removing version from your configuration does not remove or clear a version from the option in AWS. AWS may assign a default version. Not including version in your configuration means that the AWS provider will ignore a previously set value, a value set by AWS, and any version changes.
    vpcSecurityGroupMemberships List<String>
    List of VPC Security Groups for which the option is enabled.

    OptionGroupOptionOptionSetting, OptionGroupOptionOptionSettingArgs

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

    Import

    Using pulumi import, import DB option groups using the name. For example:

    $ 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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-aws