com.pulumi.aws.rds.kotlin.SubnetGroup.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.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 [SubnetGroup].
*/
@PulumiTagMarker
public class SubnetGroupResourceBuilder internal constructor() {
public var name: String? = null
public var args: SubnetGroupArgs = SubnetGroupArgs()
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 SubnetGroupArgsBuilder.() -> Unit) {
val builder = SubnetGroupArgsBuilder()
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(): SubnetGroup {
val builtJavaResource = com.pulumi.aws.rds.SubnetGroup(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return SubnetGroup(builtJavaResource)
}
}
/**
* Provides an RDS DB subnet group resource.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const _default = new aws.rds.SubnetGroup("default", {
* name: "main",
* subnetIds: [
* frontend.id,
* backend.id,
* ],
* tags: {
* Name: "My DB subnet group",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* default = aws.rds.SubnetGroup("default",
* name="main",
* subnet_ids=[
* frontend["id"],
* backend["id"],
* ],
* tags={
* "Name": "My DB subnet group",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var @default = new Aws.Rds.SubnetGroup("default", new()
* {
* Name = "main",
* SubnetIds = new[]
* {
* frontend.Id,
* backend.Id,
* },
* Tags =
* {
* { "Name", "My DB subnet group" },
* },
* });
* });
* ```
* ```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.NewSubnetGroup(ctx, "default", &rds.SubnetGroupArgs{
* Name: pulumi.String("main"),
* SubnetIds: pulumi.StringArray{
* frontend.Id,
* backend.Id,
* },
* Tags: pulumi.StringMap{
* "Name": pulumi.String("My DB subnet group"),
* },
* })
* 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.SubnetGroup;
* import com.pulumi.aws.rds.SubnetGroupArgs;
* 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 default_ = new SubnetGroup("default", SubnetGroupArgs.builder()
* .name("main")
* .subnetIds(
* frontend.id(),
* backend.id())
* .tags(Map.of("Name", "My DB subnet group"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: aws:rds:SubnetGroup
* properties:
* name: main
* subnetIds:
* - ${frontend.id}
* - ${backend.id}
* tags:
* Name: My DB subnet group
* ```
*
* ## Import
* Using `pulumi import`, import DB Subnet groups using the `name`. For example:
* ```sh
* $ pulumi import aws:rds/subnetGroup:SubnetGroup default production-subnet-group
* ```
*/
public class SubnetGroup internal constructor(
override val javaResource: com.pulumi.aws.rds.SubnetGroup,
) : KotlinCustomResource(javaResource, SubnetGroupMapper) {
/**
* The ARN of the db subnet group.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The description of the DB subnet group. Defaults to "Managed by Pulumi".
*/
public val description: Output
get() = javaResource.description().applyValue({ args0 -> args0 })
/**
* The name of the DB subnet group. If omitted, the provider will assign a random, unique name.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
public val namePrefix: Output
get() = javaResource.namePrefix().applyValue({ args0 -> args0 })
/**
* A list of VPC subnet IDs.
*/
public val subnetIds: Output>
get() = javaResource.subnetIds().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* The network type of the db subnet group.
*/
public val supportedNetworkTypes: Output>
get() = javaResource.supportedNetworkTypes().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* A 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)
})
/**
* A 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()
})
/**
* Provides the VPC ID of the DB subnet group.
*/
public val vpcId: Output
get() = javaResource.vpcId().applyValue({ args0 -> args0 })
}
public object SubnetGroupMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.rds.SubnetGroup::class == javaResource::class
override fun map(javaResource: Resource): SubnetGroup = SubnetGroup(
javaResource as
com.pulumi.aws.rds.SubnetGroup,
)
}
/**
* @see [SubnetGroup].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [SubnetGroup].
*/
public suspend fun subnetGroup(name: String, block: suspend SubnetGroupResourceBuilder.() -> Unit): SubnetGroup {
val builder = SubnetGroupResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [SubnetGroup].
* @param name The _unique_ name of the resulting resource.
*/
public fun subnetGroup(name: String): SubnetGroup {
val builder = SubnetGroupResourceBuilder()
builder.name(name)
return builder.build()
}