@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
198 lines (197 loc) • 6.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to get information about an OpenSearch Domain
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const myDomain = aws.opensearch.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 {
/**
* 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 OpenSearch domain's advanced security options. The block consists of the following attributes:
*/
readonly advancedSecurityOptions: outputs.opensearch.GetDomainAdvancedSecurityOption[];
/**
* ARN of the domain.
*/
readonly arn: string;
/**
* Configuration of the Auto-Tune options of the domain.
*/
readonly autoTuneOptions: outputs.opensearch.GetDomainAutoTuneOption[];
/**
* Cluster configuration of the domain.
*/
readonly clusterConfigs: outputs.opensearch.GetDomainClusterConfig[];
/**
* Domain Amazon Cognito Authentication options for Dashboard.
*/
readonly cognitoOptions: outputs.opensearch.GetDomainCognitoOption[];
/**
* Status of the creation of the domain.
*/
readonly created: boolean;
/**
* Domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html).
*/
readonly dashboardEndpoint: string;
/**
* V2 domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html)
*/
readonly dashboardEndpointV2: string;
/**
* Status of the deletion of the domain.
*/
readonly deleted: boolean;
/**
* Dual stack hosted zone ID for the domain.
*/
readonly domainEndpointV2HostedZoneId: string;
/**
* Unique identifier for the domain.
*/
readonly domainId: string;
readonly domainName: string;
/**
* EBS Options for the instances in the domain.
*/
readonly ebsOptions: outputs.opensearch.GetDomainEbsOption[];
/**
* Domain encryption at rest related options.
*/
readonly encryptionAtRests: outputs.opensearch.GetDomainEncryptionAtRest[];
/**
* Domain-specific endpoint used to submit index, search, and data upload requests.
*/
readonly endpoint: string;
/**
* V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
*/
readonly endpointV2: string;
/**
* OpenSearch version for the domain.
*/
readonly engineVersion: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Configuration for enabling and managing IAM Identity Center integration within a domain.
*/
readonly identityCenterOptions: outputs.opensearch.GetDomainIdentityCenterOption[];
/**
* Type of IP addresses supported by the endpoint for the domain.
*/
readonly ipAddressType: string;
/**
* Domain log publishing related options.
*/
readonly logPublishingOptions: outputs.opensearch.GetDomainLogPublishingOption[];
/**
* Domain in transit encryption related options.
*/
readonly nodeToNodeEncryptions: outputs.opensearch.GetDomainNodeToNodeEncryption[];
/**
* Off Peak update options
*/
readonly offPeakWindowOptions: outputs.opensearch.GetDomainOffPeakWindowOptions;
/**
* Status of a configuration change in the domain.
*/
readonly processing: boolean;
readonly region: string;
/**
* Domain snapshot related options.
*/
readonly snapshotOptions: outputs.opensearch.GetDomainSnapshotOption[];
/**
* Software update options for the domain
*/
readonly softwareUpdateOptions: outputs.opensearch.GetDomainSoftwareUpdateOption[];
/**
* Tags assigned to the domain.
*/
readonly tags: {
[key: string]: string;
};
/**
* VPC Options for private OpenSearch domains.
*/
readonly vpcOptions: outputs.opensearch.GetDomainVpcOption[];
}
/**
* Use this data source to get information about an OpenSearch Domain
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const myDomain = aws.opensearch.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>;
}>;
}