com.pulumi.aws.rds.kotlin.InstanceDesiredState.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.rds.kotlin

import com.pulumi.aws.rds.kotlin.outputs.InstanceDesiredStateTimeouts
import com.pulumi.aws.rds.kotlin.outputs.InstanceDesiredStateTimeouts.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.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [InstanceDesiredState].
 */
@PulumiTagMarker
public class InstanceDesiredStateResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: InstanceDesiredStateArgs = InstanceDesiredStateArgs()

    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 InstanceDesiredStateArgsBuilder.() -> Unit) {
        val builder = InstanceDesiredStateArgsBuilder()
        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(): InstanceDesiredState {
        val builtJavaResource = com.pulumi.aws.rds.InstanceDesiredState(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return InstanceDesiredState(builtJavaResource)
    }
}

/**
 * Resource for managing an AWS RDS (Relational Database) RDS Instance State.
 * > Destruction of this resource is a no-op and **will not** modify the instance state
 * ## Example Usage
 * ### Basic Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const test = new aws.rds.InstanceDesiredState("test", {
 *     identifier: testAwsDbInstance.identifier,
 *     state: "available",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * test = aws.rds.InstanceDesiredState("test",
 *     identifier=test_aws_db_instance["identifier"],
 *     state="available")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var test = new Aws.Rds.InstanceDesiredState("test", new()
 *     {
 *         Identifier = testAwsDbInstance.Identifier,
 *         State = "available",
 *     });
 * });
 * ```
 * ```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.NewInstanceDesiredState(ctx, "test", &rds.InstanceDesiredStateArgs{
 * 			Identifier: pulumi.Any(testAwsDbInstance.Identifier),
 * 			State:      pulumi.String("available"),
 * 		})
 * 		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.InstanceDesiredState;
 * import com.pulumi.aws.rds.InstanceDesiredStateArgs;
 * 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 test = new InstanceDesiredState("test", InstanceDesiredStateArgs.builder()
 *             .identifier(testAwsDbInstance.identifier())
 *             .state("available")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   test:
 *     type: aws:rds:InstanceDesiredState
 *     properties:
 *       identifier: ${testAwsDbInstance.identifier}
 *       state: available
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example:
 * ```sh
 * $ pulumi import aws:rds/instanceDesiredState:InstanceDesiredState example rds_instance_state-id-12345678
 * ```
 */
public class InstanceDesiredState internal constructor(
    override val javaResource: com.pulumi.aws.rds.InstanceDesiredState,
) : KotlinCustomResource(javaResource, InstanceDesiredStateMapper) {
    /**
     * DB Instance Identifier
     */
    public val identifier: Output
        get() = javaResource.identifier().applyValue({ args0 -> args0 })

    /**
     * Configured state of the DB Instance. Valid values are `available` and `stopped`.
     */
    public val state: Output
        get() = javaResource.state().applyValue({ args0 -> args0 })

    public val timeouts: Output?
        get() = javaResource.timeouts().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    toKotlin(args0)
                })
            }).orElse(null)
        })
}

public object InstanceDesiredStateMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.aws.rds.InstanceDesiredState::class == javaResource::class

    override fun map(javaResource: Resource): InstanceDesiredState = InstanceDesiredState(
        javaResource
            as com.pulumi.aws.rds.InstanceDesiredState,
    )
}

/**
 * @see [InstanceDesiredState].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [InstanceDesiredState].
 */
public suspend fun instanceDesiredState(
    name: String,
    block: suspend InstanceDesiredStateResourceBuilder.() -> Unit,
): InstanceDesiredState {
    val builder = InstanceDesiredStateResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [InstanceDesiredState].
 * @param name The _unique_ name of the resulting resource.
 */
public fun instanceDesiredState(name: String): InstanceDesiredState {
    val builder = InstanceDesiredStateResourceBuilder()
    builder.name(name)
    return builder.build()
}