Class OptionGroup

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

• MariaDB Options
• Microsoft SQL Server Options
• MySQL Options
• Oracle Options

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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

OptionGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Rds

Assembly: Pulumi.Aws.dll

Syntax

public class OptionGroup : CustomResource

Constructors

OptionGroup(String, OptionGroupArgs, CustomResourceOptions)

Create a OptionGroup resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
OptionGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the db option group.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

EngineName

Specifies the name of the engine that this option group should be associated with.

Declaration

public Output<string> EngineName { get; }

Property Value

Type	Description
Output<System.String>

MajorEngineVersion

Specifies the major version of the engine that this option group should be associated with.

Declaration

public Output<string> MajorEngineVersion { get; }

Property Value

Type	Description
Output<System.String>

Name

The Name of the setting.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.

Declaration

public Output<string> NamePrefix { get; }

Property Value

Type	Description
Output<System.String>

OptionGroupDescription

The description of the option group. Defaults to "Managed by Pulumi".

Declaration

public Output<string> OptionGroupDescription { get; }

Property Value

Type	Description
Output<System.String>

Options

A list of Options to apply.

Declaration

public Output<ImmutableArray<OptionGroupOption>> Options { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<OptionGroupOption>>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, OptionGroupState, CustomResourceOptions)

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

Declaration

public static OptionGroup Get(string name, Input<string> id, OptionGroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
OptionGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
OptionGroup