@pulumi/aws/elasticsearch/getDomain.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about an Elasticsearch Domain
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const myDomain = aws.elasticsearch.getDomain({
 *     domainName: "my-domain-name",
 * });
 * ```
 */
export declare function getDomain(args: GetDomainArgs, opts?: pulumi.InvokeOptions): Promise<GetDomainResult>;
/**
 * A collection of arguments for invoking getDomain.
 */
export interface GetDomainArgs {
    /**
     * Name of the domain.
     */
    domainName: 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;
    /**
     * Tags assigned to the domain.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getDomain.
 */
export interface GetDomainResult {
    /**
     * The policy document attached to the domain.
     */
    readonly accessPolicies: string;
    /**
     * Key-value string pairs to specify advanced configuration options.
     */
    readonly advancedOptions: {
        [key: string]: string;
    };
    /**
     * Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes:
     */
    readonly advancedSecurityOptions: outputs.elasticsearch.GetDomainAdvancedSecurityOption[];
    /**
     * The ARN of the domain.
     */
    readonly arn: string;
    /**
     * Configuration of the Auto-Tune options of the domain.
     */
    readonly autoTuneOptions: outputs.elasticsearch.GetDomainAutoTuneOption[];
    /**
     * Cluster configuration of the domain.
     */
    readonly clusterConfigs: outputs.elasticsearch.GetDomainClusterConfig[];
    /**
     * Domain Amazon Cognito Authentication options for Kibana.
     */
    readonly cognitoOptions: outputs.elasticsearch.GetDomainCognitoOption[];
    /**
     * Status of the creation of the domain.
     */
    readonly created: boolean;
    /**
     * Status of the deletion of the domain.
     */
    readonly deleted: boolean;
    /**
     * Unique identifier for the domain.
     */
    readonly domainId: string;
    readonly domainName: string;
    /**
     * EBS Options for the instances in the domain.
     */
    readonly ebsOptions: outputs.elasticsearch.GetDomainEbsOption[];
    /**
     * Elasticsearch version for the domain.
     */
    readonly elasticsearchVersion: string;
    /**
     * Domain encryption at rest related options.
     */
    readonly encryptionAtRests: outputs.elasticsearch.GetDomainEncryptionAtRest[];
    /**
     * Domain-specific endpoint used to submit index, search, and data upload requests.
     */
    readonly endpoint: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Domain-specific endpoint used to access the Kibana application.
     */
    readonly kibanaEndpoint: string;
    /**
     * Domain log publishing related options.
     */
    readonly logPublishingOptions: outputs.elasticsearch.GetDomainLogPublishingOption[];
    /**
     * Domain in transit encryption related options.
     */
    readonly nodeToNodeEncryptions: outputs.elasticsearch.GetDomainNodeToNodeEncryption[];
    /**
     * Status of a configuration change in the domain.
     */
    readonly processing: boolean;
    readonly region: string;
    /**
     * Domain snapshot related options.
     */
    readonly snapshotOptions: outputs.elasticsearch.GetDomainSnapshotOption[];
    /**
     * Tags assigned to the domain.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * VPC Options for private Elasticsearch domains.
     */
    readonly vpcOptions: outputs.elasticsearch.GetDomainVpcOption[];
}
/**
 * Use this data source to get information about an Elasticsearch Domain
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const myDomain = aws.elasticsearch.getDomain({
 *     domainName: "my-domain-name",
 * });
 * ```
 */
export declare function getDomainOutput(args: GetDomainOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDomainResult>;
/**
 * A collection of arguments for invoking getDomain.
 */
export interface GetDomainOutputArgs {
    /**
     * Name of the domain.
     */
    domainName: 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>;
    /**
     * Tags assigned to the domain.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}