com.pulumi.aws.kinesisanalyticsv2.kotlin.ApplicationSnapshot.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.kinesisanalyticsv2.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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

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

    public var args: ApplicationSnapshotArgs = ApplicationSnapshotArgs()

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

/**
 * Manages a Kinesis Analytics v2 Application Snapshot.
 * Snapshots are the AWS implementation of [Flink Savepoints](https://ci.apache.org/projects/flink/flink-docs-release-1.11/ops/state/savepoints.html).
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const example = new aws.kinesisanalyticsv2.ApplicationSnapshot("example", {
 *     applicationName: exampleAwsKinesisanalyticsv2Application.name,
 *     snapshotName: "example-snapshot",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * example = aws.kinesisanalyticsv2.ApplicationSnapshot("example",
 *     application_name=example_aws_kinesisanalyticsv2_application["name"],
 *     snapshot_name="example-snapshot")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Aws.KinesisAnalyticsV2.ApplicationSnapshot("example", new()
 *     {
 *         ApplicationName = exampleAwsKinesisanalyticsv2Application.Name,
 *         SnapshotName = "example-snapshot",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesisanalyticsv2"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := kinesisanalyticsv2.NewApplicationSnapshot(ctx, "example", &kinesisanalyticsv2.ApplicationSnapshotArgs{
 * 			ApplicationName: pulumi.Any(exampleAwsKinesisanalyticsv2Application.Name),
 * 			SnapshotName:    pulumi.String("example-snapshot"),
 * 		})
 * 		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.kinesisanalyticsv2.ApplicationSnapshot;
 * import com.pulumi.aws.kinesisanalyticsv2.ApplicationSnapshotArgs;
 * 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 ApplicationSnapshot("example", ApplicationSnapshotArgs.builder()
 *             .applicationName(exampleAwsKinesisanalyticsv2Application.name())
 *             .snapshotName("example-snapshot")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: aws:kinesisanalyticsv2:ApplicationSnapshot
 *     properties:
 *       applicationName: ${exampleAwsKinesisanalyticsv2Application.name}
 *       snapshotName: example-snapshot
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import `aws_kinesisanalyticsv2_application` using `application_name` together with `snapshot_name`. For example:
 * ```sh
 * $ pulumi import aws:kinesisanalyticsv2/applicationSnapshot:ApplicationSnapshot example example-application/example-snapshot
 * ```
 */
public class ApplicationSnapshot internal constructor(
    override val javaResource: com.pulumi.aws.kinesisanalyticsv2.ApplicationSnapshot,
) : KotlinCustomResource(javaResource, ApplicationSnapshotMapper) {
    /**
     * The name of an existing  Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
     */
    public val applicationName: Output
        get() = javaResource.applicationName().applyValue({ args0 -> args0 })

    /**
     * The current application version ID when the snapshot was created.
     */
    public val applicationVersionId: Output
        get() = javaResource.applicationVersionId().applyValue({ args0 -> args0 })

    /**
     * The timestamp of the application snapshot.
     */
    public val snapshotCreationTimestamp: Output
        get() = javaResource.snapshotCreationTimestamp().applyValue({ args0 -> args0 })

    /**
     * The name of the application snapshot.
     */
    public val snapshotName: Output
        get() = javaResource.snapshotName().applyValue({ args0 -> args0 })
}

public object ApplicationSnapshotMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.aws.kinesisanalyticsv2.ApplicationSnapshot::class == javaResource::class

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

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

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