com.pulumi.aws.rds.kotlin.OptionGroup.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.rds.kotlin
import com.pulumi.aws.rds.kotlin.outputs.OptionGroupOption
import com.pulumi.aws.rds.kotlin.outputs.OptionGroupOption.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [OptionGroup].
*/
@PulumiTagMarker
public class OptionGroupResourceBuilder internal constructor() {
public var name: String? = null
public var args: OptionGroupArgs = OptionGroupArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend OptionGroupArgsBuilder.() -> Unit) {
val builder = OptionGroupArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): OptionGroup {
val builtJavaResource = com.pulumi.aws.rds.OptionGroup(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return OptionGroup(builtJavaResource)
}
}
/**
* Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at:
* * [MariaDB Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Options.html)
* * [Microsoft SQL Server Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.html)
* * [MySQL Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.Options.html)
* * [Oracle Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.html)
* ## Example Usage
*
* ```typescript
* 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",
* },
* ],
* });
* ```
* ```python
* 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=[
* {
* "option_name": "Timezone",
* "option_settings": [{
* "name": "TIME_ZONE",
* "value": "UTC",
* }],
* },
* {
* "option_name": "SQLSERVER_BACKUP_RESTORE",
* "option_settings": [{
* "name": "IAM_ROLE_ARN",
* "value": example_aws_iam_role["arn"],
* }],
* },
* {
* "option_name": "TDE",
* },
* ])
* ```
* ```csharp
* 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",
* },
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Delete).
* ## Import
* Using `pulumi import`, import DB option groups using the `name`. For example:
* ```sh
* $ pulumi import aws:rds/optionGroup:OptionGroup example mysql-option-group
* ```
*/
public class OptionGroup internal constructor(
override val javaResource: com.pulumi.aws.rds.OptionGroup,
) : KotlinCustomResource(javaResource, OptionGroupMapper) {
/**
* ARN of the DB option group.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* Specifies the name of the engine that this option group should be associated with.
*/
public val engineName: Output
get() = javaResource.engineName().applyValue({ args0 -> args0 })
/**
* Specifies the major version of the engine that this option group should be associated with.
*/
public val majorEngineVersion: Output
get() = javaResource.majorEngineVersion().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.
*/
public val namePrefix: Output
get() = javaResource.namePrefix().applyValue({ args0 -> args0 })
/**
* Description of the option group.
*/
public val optionGroupDescription: Output
get() = javaResource.optionGroupDescription().applyValue({ args0 -> args0 })
/**
* The options to apply. See `option` Block below for more details.
*/
public val options: Output>?
get() = javaResource.options().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
})
}).orElse(null)
})
/**
* Set to true if you do not wish the option group to be deleted at destroy time, and instead just remove the option group from the Pulumi state.
*/
public val skipDestroy: Output?
get() = javaResource.skipDestroy().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
}
public object OptionGroupMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.rds.OptionGroup::class == javaResource::class
override fun map(javaResource: Resource): OptionGroup = OptionGroup(
javaResource as
com.pulumi.aws.rds.OptionGroup,
)
}
/**
* @see [OptionGroup].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [OptionGroup].
*/
public suspend fun optionGroup(name: String, block: suspend OptionGroupResourceBuilder.() -> Unit): OptionGroup {
val builder = OptionGroupResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [OptionGroup].
* @param name The _unique_ name of the resulting resource.
*/
public fun optionGroup(name: String): OptionGroup {
val builder = OptionGroupResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy