@pulumi/aws/opensearch/getServerlessCollection.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Data source for managing an AWS OpenSearch Serverless Collection.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.opensearch.getServerlessCollection({
 *     name: "example",
 * });
 * ```
 */
export declare function getServerlessCollection(args?: GetServerlessCollectionArgs, opts?: pulumi.InvokeOptions): Promise<GetServerlessCollectionResult>;
/**
 * A collection of arguments for invoking getServerlessCollection.
 */
export interface GetServerlessCollectionArgs {
    /**
     * ID of the collection.
     */
    id?: string;
    /**
     * Name of the collection.
     *
     * > Exactly one of `id` or `name` is required.
     */
    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;
}
/**
 * A collection of values returned by getServerlessCollection.
 */
export interface GetServerlessCollectionResult {
    /**
     * Amazon Resource Name (ARN) of the collection.
     */
    readonly arn: string;
    /**
     * Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
     */
    readonly collectionEndpoint: string;
    /**
     * Date the Collection was created.
     */
    readonly createdDate: string;
    /**
     * Collection-specific endpoint used to access OpenSearch Dashboards.
     */
    readonly dashboardEndpoint: string;
    /**
     * Description of the collection.
     */
    readonly description: string;
    /**
     * A failure code associated with the collection.
     */
    readonly failureCode: string;
    readonly failureMessage: string;
    readonly id: string;
    /**
     * The ARN of the Amazon Web Services KMS key used to encrypt the collection.
     */
    readonly kmsKeyArn: string;
    /**
     * Date the Collection was last modified.
     */
    readonly lastModifiedDate: string;
    readonly name: string;
    readonly region: string;
    /**
     * Indicates whether standby replicas should be used for a collection.
     */
    readonly standbyReplicas: string;
    /**
     * A map of tags to assign to the collection.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Type of collection.
     */
    readonly type: string;
}
/**
 * Data source for managing an AWS OpenSearch Serverless Collection.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.opensearch.getServerlessCollection({
 *     name: "example",
 * });
 * ```
 */
export declare function getServerlessCollectionOutput(args?: GetServerlessCollectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServerlessCollectionResult>;
/**
 * A collection of arguments for invoking getServerlessCollection.
 */
export interface GetServerlessCollectionOutputArgs {
    /**
     * ID of the collection.
     */
    id?: pulumi.Input<string>;
    /**
     * Name of the collection.
     *
     * > Exactly one of `id` or `name` is required.
     */
    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>;
}