UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

111 lines (110 loc) 3.02 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Provides information about a MemoryDB Snapshot. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.memorydb.getSnapshot({ * name: "my-snapshot", * }); * ``` */ export declare function getSnapshot(args: GetSnapshotArgs, opts?: pulumi.InvokeOptions): Promise<GetSnapshotResult>; /** * A collection of arguments for invoking getSnapshot. */ export interface GetSnapshotArgs { /** * Name of the snapshot. */ name: 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?: string; /** * Map of tags assigned to the snapshot. */ tags?: { [key: string]: string; }; } /** * A collection of values returned by getSnapshot. */ export interface GetSnapshotResult { /** * ARN of the snapshot. */ readonly arn: string; /** * The configuration of the cluster from which the snapshot was taken. */ readonly clusterConfigurations: outputs.memorydb.GetSnapshotClusterConfiguration[]; /** * Name of the MemoryDB cluster that this snapshot was taken from. */ readonly clusterName: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * ARN of the KMS key used to encrypt the snapshot at rest. */ readonly kmsKeyArn: string; /** * Name of the cluster. */ readonly name: string; readonly region: string; /** * Whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`). */ readonly source: string; /** * Map of tags assigned to the snapshot. */ readonly tags: { [key: string]: string; }; } /** * Provides information about a MemoryDB Snapshot. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.memorydb.getSnapshot({ * name: "my-snapshot", * }); * ``` */ export declare function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSnapshotResult>; /** * A collection of arguments for invoking getSnapshot. */ export interface GetSnapshotOutputArgs { /** * Name of the snapshot. */ name: 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>; /** * Map of tags assigned to the snapshot. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }