1. Packages
  2. AWS Classic
  3. API Docs
  4. kinesisanalyticsv2
  5. ApplicationSnapshot

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.kinesisanalyticsv2.ApplicationSnapshot

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Manages a Kinesis Analytics v2 Application Snapshot. Snapshots are the AWS implementation of Flink Savepoints.

    Example Usage

    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 pulumi
    import pulumi_aws as aws
    
    example = aws.kinesisanalyticsv2.ApplicationSnapshot("example",
        application_name=example_aws_kinesisanalyticsv2_application["name"],
        snapshot_name="example-snapshot")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    resources:
      example:
        type: aws:kinesisanalyticsv2:ApplicationSnapshot
        properties:
          applicationName: ${exampleAwsKinesisanalyticsv2Application.name}
          snapshotName: example-snapshot
    

    Create ApplicationSnapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApplicationSnapshot(name: string, args: ApplicationSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def ApplicationSnapshot(resource_name: str,
                            args: ApplicationSnapshotArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplicationSnapshot(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            application_name: Optional[str] = None,
                            snapshot_name: Optional[str] = None)
    func NewApplicationSnapshot(ctx *Context, name string, args ApplicationSnapshotArgs, opts ...ResourceOption) (*ApplicationSnapshot, error)
    public ApplicationSnapshot(string name, ApplicationSnapshotArgs args, CustomResourceOptions? opts = null)
    public ApplicationSnapshot(String name, ApplicationSnapshotArgs args)
    public ApplicationSnapshot(String name, ApplicationSnapshotArgs args, CustomResourceOptions options)
    
    type: aws:kinesisanalyticsv2:ApplicationSnapshot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApplicationSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationSnapshotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationSnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var applicationSnapshotResource = new Aws.KinesisAnalyticsV2.ApplicationSnapshot("applicationSnapshotResource", new()
    {
        ApplicationName = "string",
        SnapshotName = "string",
    });
    
    example, err := kinesisanalyticsv2.NewApplicationSnapshot(ctx, "applicationSnapshotResource", &kinesisanalyticsv2.ApplicationSnapshotArgs{
    	ApplicationName: pulumi.String("string"),
    	SnapshotName:    pulumi.String("string"),
    })
    
    var applicationSnapshotResource = new ApplicationSnapshot("applicationSnapshotResource", ApplicationSnapshotArgs.builder()
        .applicationName("string")
        .snapshotName("string")
        .build());
    
    application_snapshot_resource = aws.kinesisanalyticsv2.ApplicationSnapshot("applicationSnapshotResource",
        application_name="string",
        snapshot_name="string")
    
    const applicationSnapshotResource = new aws.kinesisanalyticsv2.ApplicationSnapshot("applicationSnapshotResource", {
        applicationName: "string",
        snapshotName: "string",
    });
    
    type: aws:kinesisanalyticsv2:ApplicationSnapshot
    properties:
        applicationName: string
        snapshotName: string
    

    ApplicationSnapshot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApplicationSnapshot resource accepts the following input properties:

    ApplicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    SnapshotName string
    The name of the application snapshot.
    ApplicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    SnapshotName string
    The name of the application snapshot.
    applicationName String
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    snapshotName String
    The name of the application snapshot.
    applicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    snapshotName string
    The name of the application snapshot.
    application_name str
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    snapshot_name str
    The name of the application snapshot.
    applicationName String
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    snapshotName String
    The name of the application snapshot.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationSnapshot resource produces the following output properties:

    ApplicationVersionId int
    The current application version ID when the snapshot was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SnapshotCreationTimestamp string
    The timestamp of the application snapshot.
    ApplicationVersionId int
    The current application version ID when the snapshot was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SnapshotCreationTimestamp string
    The timestamp of the application snapshot.
    applicationVersionId Integer
    The current application version ID when the snapshot was created.
    id String
    The provider-assigned unique ID for this managed resource.
    snapshotCreationTimestamp String
    The timestamp of the application snapshot.
    applicationVersionId number
    The current application version ID when the snapshot was created.
    id string
    The provider-assigned unique ID for this managed resource.
    snapshotCreationTimestamp string
    The timestamp of the application snapshot.
    application_version_id int
    The current application version ID when the snapshot was created.
    id str
    The provider-assigned unique ID for this managed resource.
    snapshot_creation_timestamp str
    The timestamp of the application snapshot.
    applicationVersionId Number
    The current application version ID when the snapshot was created.
    id String
    The provider-assigned unique ID for this managed resource.
    snapshotCreationTimestamp String
    The timestamp of the application snapshot.

    Look up Existing ApplicationSnapshot Resource

    Get an existing ApplicationSnapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApplicationSnapshotState, opts?: CustomResourceOptions): ApplicationSnapshot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_name: Optional[str] = None,
            application_version_id: Optional[int] = None,
            snapshot_creation_timestamp: Optional[str] = None,
            snapshot_name: Optional[str] = None) -> ApplicationSnapshot
    func GetApplicationSnapshot(ctx *Context, name string, id IDInput, state *ApplicationSnapshotState, opts ...ResourceOption) (*ApplicationSnapshot, error)
    public static ApplicationSnapshot Get(string name, Input<string> id, ApplicationSnapshotState? state, CustomResourceOptions? opts = null)
    public static ApplicationSnapshot get(String name, Output<String> id, ApplicationSnapshotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    ApplicationVersionId int
    The current application version ID when the snapshot was created.
    SnapshotCreationTimestamp string
    The timestamp of the application snapshot.
    SnapshotName string
    The name of the application snapshot.
    ApplicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    ApplicationVersionId int
    The current application version ID when the snapshot was created.
    SnapshotCreationTimestamp string
    The timestamp of the application snapshot.
    SnapshotName string
    The name of the application snapshot.
    applicationName String
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    applicationVersionId Integer
    The current application version ID when the snapshot was created.
    snapshotCreationTimestamp String
    The timestamp of the application snapshot.
    snapshotName String
    The name of the application snapshot.
    applicationName string
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    applicationVersionId number
    The current application version ID when the snapshot was created.
    snapshotCreationTimestamp string
    The timestamp of the application snapshot.
    snapshotName string
    The name of the application snapshot.
    application_name str
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    application_version_id int
    The current application version ID when the snapshot was created.
    snapshot_creation_timestamp str
    The timestamp of the application snapshot.
    snapshot_name str
    The name of the application snapshot.
    applicationName String
    The name of an existing Kinesis Analytics v2 Application. Note that the application must be running for a snapshot to be created.
    applicationVersionId Number
    The current application version ID when the snapshot was created.
    snapshotCreationTimestamp String
    The timestamp of the application snapshot.
    snapshotName String
    The name of the application snapshot.

    Import

    Using pulumi import, import aws_kinesisanalyticsv2_application using application_name together with snapshot_name. For example:

    $ pulumi import aws:kinesisanalyticsv2/applicationSnapshot:ApplicationSnapshot example example-application/example-snapshot
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi