OptionGroup

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Rds.OptionGroup("example", new Aws.Rds.OptionGroupArgs
        {
            EngineName = "sqlserver-ee",
            MajorEngineVersion = "11.00",
            Options = 
            {
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "Timezone",
                    OptionSettings = 
                    {
                        new Aws.Rds.Inputs.OptionGroupOptionOptionSettingArgs
                        {
                            Name = "TIME_ZONE",
                            Value = "UTC",
                        },
                    },
                },
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "SQLSERVER_BACKUP_RESTORE",
                    OptionSettings = 
                    {
                        new Aws.Rds.Inputs.OptionGroupOptionOptionSettingArgs
                        {
                            Name = "IAM_ROLE_ARN",
                            Value = aws_iam_role.Example.Arn,
                        },
                    },
                },
                new Aws.Rds.Inputs.OptionGroupOptionArgs
                {
                    OptionName = "TDE",
                },
            },
            OptionGroupDescription = "Option Group",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/rds"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rds.NewOptionGroup(ctx, "example", &rds.OptionGroupArgs{
            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.String(aws_iam_role.Example.Arn),
                        },
                    },
                },
                &rds.OptionGroupOptionArgs{
                    OptionName: pulumi.String("TDE"),
                },
            },
            OptionGroupDescription: pulumi.String("Option Group"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.rds.OptionGroup("example",
    engine_name="sqlserver-ee",
    major_engine_version="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",
        },
    ],
    option_group_description="Option Group")

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

const example = new aws.rds.OptionGroup("example", {
    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",
        },
    ],
    optionGroupDescription: "Option Group",
});

Create a OptionGroup Resource

new OptionGroup(name: string, args: OptionGroupArgs, opts?: CustomResourceOptions);

def OptionGroup(resource_name, opts=None, engine_name=None, major_engine_version=None, name=None, name_prefix=None, option_group_description=None, options=None, tags=None, __props__=None);

func NewOptionGroup(ctx *Context, name string, args OptionGroupArgs, opts ...ResourceOption) (*OptionGroup, error)

public OptionGroup(string name, OptionGroupArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

OptionGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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: 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<OptionGroupOptionArgs>: A list of Options to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

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 map[string]string: A map of tags to assign to the resource.

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.

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 List[OptionGroupOption]: A list of Options to apply.
tags Dict[str, str]: A map of tags to assign to the resource.

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.

Arn string: The ARN of the db option group.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the db option group.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the db option group.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, arn=None, engine_name=None, major_engine_version=None, name=None, name_prefix=None, option_group_description=None, options=None, tags=None, __props__=None);

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)

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.

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<OptionGroupOptionArgs>: A list of Options to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

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 map[string]string: A map of tags to assign to the resource.

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.

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 List[OptionGroupOption]: A list of Options to apply.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

OptionGroupOption

See the input and output API doc for this type.

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<OptionGroupOptionOptionSettingArgs>: 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 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.

optionName str: The Name of the Option (e.g. MEMCACHED).
dbSecurityGroupMemberships List[str]: A list of DB Security Groups for which the option is enabled.
optionSettings List[OptionGroupOptionOptionSetting]: A list of option settings to apply.
port float: The Port number when connecting to the Option (e.g. 11211).
version str: The version of the option (e.g. 13.1.0.0).
vpcSecurityGroupMemberships List[str]: A list of VPC Security Groups for which the option is enabled.

OptionGroupOptionOptionSetting

See the input and output API doc for this type.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud