@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
113 lines (112 loc) • 4.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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",
* });
* ```
*
* ## 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
* ```
*/
export declare class ApplicationSnapshot extends pulumi.CustomResource {
/**
* Get an existing ApplicationSnapshot resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationSnapshotState, opts?: pulumi.CustomResourceOptions): ApplicationSnapshot;
/**
* Returns true if the given object is an instance of ApplicationSnapshot. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApplicationSnapshot;
/**
* The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
*/
readonly applicationName: pulumi.Output<string>;
/**
* The current application version ID when the snapshot was created.
*/
readonly applicationVersionId: pulumi.Output<number>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The timestamp of the application snapshot.
*/
readonly snapshotCreationTimestamp: pulumi.Output<string>;
/**
* The name of the application snapshot.
*/
readonly snapshotName: pulumi.Output<string>;
/**
* Create a ApplicationSnapshot resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ApplicationSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApplicationSnapshot resources.
*/
export interface ApplicationSnapshotState {
/**
* The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
*/
applicationName?: pulumi.Input<string>;
/**
* The current application version ID when the snapshot was created.
*/
applicationVersionId?: pulumi.Input<number>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The timestamp of the application snapshot.
*/
snapshotCreationTimestamp?: pulumi.Input<string>;
/**
* The name of the application snapshot.
*/
snapshotName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApplicationSnapshot resource.
*/
export interface ApplicationSnapshotArgs {
/**
* The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
*/
applicationName: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The name of the application snapshot.
*/
snapshotName: pulumi.Input<string>;
}