pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/OptionGroup

OptionGroup

class OptionGroup : KotlinCustomResource

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

Example Usage

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

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

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

Properties

arn

val arn: Output<String>

ARN of the DB option group.

engineName

val engineName: Output<String>

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

val id: Output<String>

majorEngineVersion

val majorEngineVersion: Output<String>

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

name

val name: Output<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

val namePrefix: Output<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

val optionGroupDescription: Output<String>

Description of the option group.

options

val options: Output<List<OptionGroupOption>>?

List of options to apply.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String