UNPKG

@pulumi/aws

Version:

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

135 lines (134 loc) 5.27 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides a Keyspaces Keyspace. * * More information about keyspaces can be found in the [Keyspaces User Guide](https://docs.aws.amazon.com/keyspaces/latest/devguide/what-is-keyspaces.html). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.keyspaces.Keyspace("example", {name: "my_keyspace"}); * ``` * * ## Import * * Using `pulumi import`, import a keyspace using the `name`. For example: * * ```sh * $ pulumi import aws:keyspaces/keyspace:Keyspace example my_keyspace * ``` */ export declare class Keyspace extends pulumi.CustomResource { /** * Get an existing Keyspace 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?: KeyspaceState, opts?: pulumi.CustomResourceOptions): Keyspace; /** * Returns true if the given object is an instance of Keyspace. 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 Keyspace; /** * The ARN of the keyspace. */ readonly arn: pulumi.Output<string>; /** * The name of the keyspace to be created. */ readonly name: pulumi.Output<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. */ readonly region: pulumi.Output<string>; /** * The replication specification of the keyspace. */ readonly replicationSpecification: pulumi.Output<outputs.keyspaces.KeyspaceReplicationSpecification>; /** * A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Create a Keyspace 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?: KeyspaceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Keyspace resources. */ export interface KeyspaceState { /** * The ARN of the keyspace. */ arn?: pulumi.Input<string>; /** * The name of the keyspace to be created. */ 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>; /** * The replication specification of the keyspace. */ replicationSpecification?: pulumi.Input<inputs.keyspaces.KeyspaceReplicationSpecification>; /** * A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; } /** * The set of arguments for constructing a Keyspace resource. */ export interface KeyspaceArgs { /** * The name of the keyspace to be created. */ 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>; /** * The replication specification of the keyspace. */ replicationSpecification?: pulumi.Input<inputs.keyspaces.KeyspaceReplicationSpecification>; /** * A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }