GetDomain

Use this data source to get information about an Elasticsearch Domain

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var myDomain = Output.Create(Aws.ElasticSearch.GetDomain.InvokeAsync(new Aws.ElasticSearch.GetDomainArgs
        {
            DomainName = "my-domain-name",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/elasticsearch"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := elasticsearch.LookupDomain(ctx, &elasticsearch.LookupDomainArgs{
            DomainName: "my-domain-name",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

my_domain = aws.elasticsearch.get_domain(domain_name="my-domain-name")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const myDomain = pulumi.output(aws.elasticsearch.getDomain({
    domainName: "my-domain-name",
}, { async: true }));

Using GetDomain

function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>

function  get_domain(domain_name=None, tags=None, opts=None)

func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)

public static class GetDomain {
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DomainName string: Name of the domain.
Tags Dictionary<string, string>: The tags assigned to the domain.

DomainName string: Name of the domain.
Tags map[string]string: The tags assigned to the domain.

domainName string: Name of the domain.
tags {[key: string]: string}: The tags assigned to the domain.

domain_name str: Name of the domain.
tags Dict[str, str]: The tags assigned to the domain.

GetDomain Result

The following output properties are available:

AccessPolicies string: The policy document attached to the domain.
AdvancedOptions Dictionary<string, string>: Key-value string pairs to specify advanced configuration options.
AdvancedSecurityOptions List<GetDomainAdvancedSecurityOption>: Status of the Elasticsearch domain’s advanced security options. The block consists of the following attributes:
Arn string: The Amazon Resource Name (ARN) of the domain.
ClusterConfigs List<GetDomainClusterConfig>: Cluster configuration of the domain.
CognitoOptions List<GetDomainCognitoOption>: Domain Amazon Cognito Authentication options for Kibana.
Created bool: Status of the creation of the domain.
Deleted bool: Status of the deletion of the domain.
DomainId string: Unique identifier for the domain.
DomainName string
EbsOptions List<GetDomainEbsOption>: EBS Options for the instances in the domain.
ElasticsearchVersion string: ElasticSearch version for the domain.
EncryptionAtRests List<GetDomainEncryptionAtRest>: Domain encryption at rest related options.
Endpoint string: Domain-specific endpoint used to submit index, search, and data upload requests.
Id string: The provider-assigned unique ID for this managed resource.
KibanaEndpoint string: Domain-specific endpoint used to access the Kibana application.
LogPublishingOptions List<GetDomainLogPublishingOption>: Domain log publishing related options.
NodeToNodeEncryptions List<GetDomainNodeToNodeEncryption>: Domain in transit encryption related options.
Processing bool: Status of a configuration change in the domain. * snapshot_options – Domain snapshot related options.
SnapshotOptions List<GetDomainSnapshotOption>
Tags Dictionary<string, string>: The tags assigned to the domain.
VpcOptions List<GetDomainVpcOption>: VPC Options for private Elasticsearch domains.

AccessPolicies string: The policy document attached to the domain.
AdvancedOptions map[string]string: Key-value string pairs to specify advanced configuration options.
AdvancedSecurityOptions []GetDomainAdvancedSecurityOption: Status of the Elasticsearch domain’s advanced security options. The block consists of the following attributes:
Arn string: The Amazon Resource Name (ARN) of the domain.
ClusterConfigs []GetDomainClusterConfig: Cluster configuration of the domain.
CognitoOptions []GetDomainCognitoOption: Domain Amazon Cognito Authentication options for Kibana.
Created bool: Status of the creation of the domain.
Deleted bool: Status of the deletion of the domain.
DomainId string: Unique identifier for the domain.
DomainName string
EbsOptions []GetDomainEbsOption: EBS Options for the instances in the domain.
ElasticsearchVersion string: ElasticSearch version for the domain.
EncryptionAtRests []GetDomainEncryptionAtRest: Domain encryption at rest related options.
Endpoint string: Domain-specific endpoint used to submit index, search, and data upload requests.
Id string: The provider-assigned unique ID for this managed resource.
KibanaEndpoint string: Domain-specific endpoint used to access the Kibana application.
LogPublishingOptions []GetDomainLogPublishingOption: Domain log publishing related options.
NodeToNodeEncryptions []GetDomainNodeToNodeEncryption: Domain in transit encryption related options.
Processing bool: Status of a configuration change in the domain. * snapshot_options – Domain snapshot related options.
SnapshotOptions []GetDomainSnapshotOption
Tags map[string]string: The tags assigned to the domain.
VpcOptions []GetDomainVpcOption: VPC Options for private Elasticsearch domains.

accessPolicies string: The policy document attached to the domain.
advancedOptions {[key: string]: string}: Key-value string pairs to specify advanced configuration options.
advancedSecurityOptions GetDomainAdvancedSecurityOption[]: Status of the Elasticsearch domain’s advanced security options. The block consists of the following attributes:
arn string: The Amazon Resource Name (ARN) of the domain.
clusterConfigs GetDomainClusterConfig[]: Cluster configuration of the domain.
cognitoOptions GetDomainCognitoOption[]: Domain Amazon Cognito Authentication options for Kibana.
created boolean: Status of the creation of the domain.
deleted boolean: Status of the deletion of the domain.
domainId string: Unique identifier for the domain.
domainName string
ebsOptions GetDomainEbsOption[]: EBS Options for the instances in the domain.
elasticsearchVersion string: ElasticSearch version for the domain.
encryptionAtRests GetDomainEncryptionAtRest[]: Domain encryption at rest related options.
endpoint string: Domain-specific endpoint used to submit index, search, and data upload requests.
id string: The provider-assigned unique ID for this managed resource.
kibanaEndpoint string: Domain-specific endpoint used to access the Kibana application.
logPublishingOptions GetDomainLogPublishingOption[]: Domain log publishing related options.
nodeToNodeEncryptions GetDomainNodeToNodeEncryption[]: Domain in transit encryption related options.
processing boolean: Status of a configuration change in the domain. * snapshot_options – Domain snapshot related options.
snapshotOptions GetDomainSnapshotOption[]
tags {[key: string]: string}: The tags assigned to the domain.
vpcOptions GetDomainVpcOption[]: VPC Options for private Elasticsearch domains.

access_policies str: The policy document attached to the domain.
advanced_options Dict[str, str]: Key-value string pairs to specify advanced configuration options.
advanced_security_options List[GetDomainAdvancedSecurityOption]: Status of the Elasticsearch domain’s advanced security options. The block consists of the following attributes:
arn str: The Amazon Resource Name (ARN) of the domain.
cluster_configs List[GetDomainClusterConfig]: Cluster configuration of the domain.
cognito_options List[GetDomainCognitoOption]: Domain Amazon Cognito Authentication options for Kibana.
created bool: Status of the creation of the domain.
deleted bool: Status of the deletion of the domain.
domain_id str: Unique identifier for the domain.
domain_name str
ebs_options List[GetDomainEbsOption]: EBS Options for the instances in the domain.
elasticsearch_version str: ElasticSearch version for the domain.
encryption_at_rests List[GetDomainEncryptionAtRest]: Domain encryption at rest related options.
endpoint str: Domain-specific endpoint used to submit index, search, and data upload requests.
id str: The provider-assigned unique ID for this managed resource.
kibana_endpoint str: Domain-specific endpoint used to access the Kibana application.
log_publishing_options List[GetDomainLogPublishingOption]: Domain log publishing related options.
node_to_node_encryptions List[GetDomainNodeToNodeEncryption]: Domain in transit encryption related options.
processing bool: Status of a configuration change in the domain. * snapshot_options – Domain snapshot related options.
snapshot_options List[GetDomainSnapshotOption]
tags Dict[str, str]: The tags assigned to the domain.
vpc_options List[GetDomainVpcOption]: VPC Options for private Elasticsearch domains.

Supporting Types

GetDomainAdvancedSecurityOption

Enabled bool: Whether node to node encryption is enabled.
InternalUserDatabaseEnabled bool: Whether the internal user database is enabled.

Enabled bool: Whether node to node encryption is enabled.
InternalUserDatabaseEnabled bool: Whether the internal user database is enabled.

enabled boolean: Whether node to node encryption is enabled.
internalUserDatabaseEnabled boolean: Whether the internal user database is enabled.

enabled bool: Whether node to node encryption is enabled.
internalUserDatabaseEnabled bool: Whether the internal user database is enabled.

GetDomainClusterConfig

DedicatedMasterCount int: Number of dedicated master nodes in the cluster.
DedicatedMasterEnabled bool: Indicates whether dedicated master nodes are enabled for the cluster.
DedicatedMasterType string: Instance type of the dedicated master nodes in the cluster.
InstanceCount int: Number of instances in the cluster.
InstanceType string: Instance type of data nodes in the cluster.
WarmCount int: The number of warm nodes in the cluster.
WarmType string: The instance type for the Elasticsearch cluster’s warm nodes.
ZoneAwarenessConfigs List<GetDomainClusterConfigZoneAwarenessConfigArgs>: Configuration block containing zone awareness settings.
ZoneAwarenessEnabled bool: Indicates whether zone awareness is enabled.
WarmEnabled bool: Indicates warm storage is enabled.

DedicatedMasterCount int: Number of dedicated master nodes in the cluster.
DedicatedMasterEnabled bool: Indicates whether dedicated master nodes are enabled for the cluster.
DedicatedMasterType string: Instance type of the dedicated master nodes in the cluster.
InstanceCount int: Number of instances in the cluster.
InstanceType string: Instance type of data nodes in the cluster.
WarmCount int: The number of warm nodes in the cluster.
WarmType string: The instance type for the Elasticsearch cluster’s warm nodes.
ZoneAwarenessConfigs []GetDomainClusterConfigZoneAwarenessConfig: Configuration block containing zone awareness settings.
ZoneAwarenessEnabled bool: Indicates whether zone awareness is enabled.
WarmEnabled bool: Indicates warm storage is enabled.

dedicatedMasterCount number: Number of dedicated master nodes in the cluster.
dedicatedMasterEnabled boolean: Indicates whether dedicated master nodes are enabled for the cluster.
dedicatedMasterType string: Instance type of the dedicated master nodes in the cluster.
instanceCount number: Number of instances in the cluster.
instanceType string: Instance type of data nodes in the cluster.
warmCount number: The number of warm nodes in the cluster.
warmType string: The instance type for the Elasticsearch cluster’s warm nodes.
zoneAwarenessConfigs GetDomainClusterConfigZoneAwarenessConfig[]: Configuration block containing zone awareness settings.
zoneAwarenessEnabled boolean: Indicates whether zone awareness is enabled.
warmEnabled boolean: Indicates warm storage is enabled.

dedicatedMasterCount float: Number of dedicated master nodes in the cluster.
dedicatedMasterEnabled bool: Indicates whether dedicated master nodes are enabled for the cluster.
dedicatedMasterType str: Instance type of the dedicated master nodes in the cluster.
instance_count float: Number of instances in the cluster.
instance_type str: Instance type of data nodes in the cluster.
warmCount float: The number of warm nodes in the cluster.
warmType str: The instance type for the Elasticsearch cluster’s warm nodes.
zoneAwarenessConfigs List[GetDomainClusterConfigZoneAwarenessConfig]: Configuration block containing zone awareness settings.
zoneAwarenessEnabled bool: Indicates whether zone awareness is enabled.
warmEnabled bool: Indicates warm storage is enabled.

GetDomainClusterConfigZoneAwarenessConfig

AvailabilityZoneCount int: Number of availability zones used.

AvailabilityZoneCount int: Number of availability zones used.

availabilityZoneCount number: Number of availability zones used.

availabilityZoneCount float: Number of availability zones used.

GetDomainCognitoOption

Enabled bool: Whether node to node encryption is enabled.
IdentityPoolId string: The Cognito Identity pool used by the domain.
RoleArn string: The IAM Role with the AmazonESCognitoAccess policy attached.
UserPoolId string: The Cognito User pool used by the domain.

Enabled bool: Whether node to node encryption is enabled.
IdentityPoolId string: The Cognito Identity pool used by the domain.
RoleArn string: The IAM Role with the AmazonESCognitoAccess policy attached.
UserPoolId string: The Cognito User pool used by the domain.

enabled boolean: Whether node to node encryption is enabled.
identityPoolId string: The Cognito Identity pool used by the domain.
roleArn string: The IAM Role with the AmazonESCognitoAccess policy attached.
userPoolId string: The Cognito User pool used by the domain.

enabled bool: Whether node to node encryption is enabled.
identity_pool_id str: The Cognito Identity pool used by the domain.
role_arn str: The IAM Role with the AmazonESCognitoAccess policy attached.
user_pool_id str: The Cognito User pool used by the domain.

GetDomainEbsOption

EbsEnabled bool: Whether EBS volumes are attached to data nodes in the domain.
Iops int: The baseline input/output (I/O) performance of EBS volumes attached to data nodes.
VolumeSize int: The size of EBS volumes attached to data nodes (in GB).
VolumeType string: The type of EBS volumes attached to data nodes.

EbsEnabled bool: Whether EBS volumes are attached to data nodes in the domain.
Iops int: The baseline input/output (I/O) performance of EBS volumes attached to data nodes.
VolumeSize int: The size of EBS volumes attached to data nodes (in GB).
VolumeType string: The type of EBS volumes attached to data nodes.

ebsEnabled boolean: Whether EBS volumes are attached to data nodes in the domain.
iops number: The baseline input/output (I/O) performance of EBS volumes attached to data nodes.
volumeSize number: The size of EBS volumes attached to data nodes (in GB).
volumeType string: The type of EBS volumes attached to data nodes.

ebsEnabled bool: Whether EBS volumes are attached to data nodes in the domain.
iops float: The baseline input/output (I/O) performance of EBS volumes attached to data nodes.
volumeType str: The type of EBS volumes attached to data nodes.
volume_size float: The size of EBS volumes attached to data nodes (in GB).

GetDomainEncryptionAtRest

Enabled bool: Whether node to node encryption is enabled.
KmsKeyId string: The KMS key id used to encrypt data at rest.

Enabled bool: Whether node to node encryption is enabled.
KmsKeyId string: The KMS key id used to encrypt data at rest.

enabled boolean: Whether node to node encryption is enabled.
kmsKeyId string: The KMS key id used to encrypt data at rest.

enabled bool: Whether node to node encryption is enabled.
kms_key_id str: The KMS key id used to encrypt data at rest.

GetDomainLogPublishingOption

CloudwatchLogGroupArn string: The CloudWatch Log Group where the logs are published.
Enabled bool: Whether node to node encryption is enabled.
LogType string: The type of Elasticsearch log being published.

CloudwatchLogGroupArn string: The CloudWatch Log Group where the logs are published.
Enabled bool: Whether node to node encryption is enabled.
LogType string: The type of Elasticsearch log being published.

cloudwatchLogGroupArn string: The CloudWatch Log Group where the logs are published.
enabled boolean: Whether node to node encryption is enabled.
logType string: The type of Elasticsearch log being published.

cloudwatch_log_group_arn str: The CloudWatch Log Group where the logs are published.
enabled bool: Whether node to node encryption is enabled.
logType str: The type of Elasticsearch log being published.

GetDomainNodeToNodeEncryption

Enabled bool: Whether node to node encryption is enabled.

Enabled bool: Whether node to node encryption is enabled.

enabled boolean: Whether node to node encryption is enabled.

enabled bool: Whether node to node encryption is enabled.

GetDomainSnapshotOption

AutomatedSnapshotStartHour int: Hour during which the service takes an automated daily snapshot of the indices in the domain.

AutomatedSnapshotStartHour int: Hour during which the service takes an automated daily snapshot of the indices in the domain.

automatedSnapshotStartHour number: Hour during which the service takes an automated daily snapshot of the indices in the domain.

automatedSnapshotStartHour float: Hour during which the service takes an automated daily snapshot of the indices in the domain.

GetDomainVpcOption

AvailabilityZones List<string>: The availability zones used by the domain.
SecurityGroupIds List<string>: The security groups used by the domain.
SubnetIds List<string>: The subnets used by the domain.
VpcId string: The VPC used by the domain.

AvailabilityZones []string: The availability zones used by the domain.
SecurityGroupIds []string: The security groups used by the domain.
SubnetIds []string: The subnets used by the domain.
VpcId string: The VPC used by the domain.

availabilityZones string[]: The availability zones used by the domain.
securityGroupIds string[]: The security groups used by the domain.
subnetIds string[]: The subnets used by the domain.
vpcId string: The VPC used by the domain.

availability_zones List[str]: The availability zones used by the domain.
security_group_ids List[str]: The security groups used by the domain.
subnet_ids List[str]: The subnets used by the domain.
vpc_id str: The VPC used by the domain.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetDomain

Example Usage

Using GetDomain

GetDomain Result

Supporting Types

GetDomainAdvancedSecurityOption

GetDomainClusterConfig

GetDomainClusterConfigZoneAwarenessConfig

GetDomainCognitoOption

GetDomainEbsOption

GetDomainEncryptionAtRest

GetDomainLogPublishingOption

GetDomainNodeToNodeEncryption

GetDomainSnapshotOption

GetDomainVpcOption

Package Details

On This Page