AWS v6.73.0, Mar 19 25

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.elasticsearch.getDomain

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

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

import pulumi
import pulumi_aws as aws

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

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticsearch"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var myDomain = Aws.ElasticSearch.GetDomain.Invoke(new()
    {
        DomainName = "my-domain-name",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticsearch.ElasticsearchFunctions;
import com.pulumi.aws.elasticsearch.inputs.GetDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myDomain = ElasticsearchFunctions.getDomain(GetDomainArgs.builder()
            .domainName("my-domain-name")
            .build());

    }
}

variables:
  myDomain:
    fn::invoke:
      function: aws:elasticsearch:getDomain
      arguments:
        domainName: my-domain-name

Using getDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

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

def get_domain(domain_name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]

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

> Note: This function is named LookupDomain in the Go SDK.

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

public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)

fn::invoke:
  function: aws:elasticsearch/getDomain:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

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

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

domainName String: Name of the domain.
tags Map<String,String>: Tags assigned to the domain.

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

domain_name str: Name of the domain.
tags Mapping[str, str]: Tags assigned to the domain.

domainName String: Name of the domain.
tags Map<String>: 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 ARN of the domain.
AutoTuneOptions List<GetDomainAutoTuneOption>: Configuration of the Auto-Tune options 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.
SnapshotOptions List<GetDomainSnapshotOption>: Domain snapshot related options.
Tags Dictionary<string, string>: 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 ARN of the domain.
AutoTuneOptions []GetDomainAutoTuneOption: Configuration of the Auto-Tune options 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.
SnapshotOptions []GetDomainSnapshotOption: Domain snapshot related options.
Tags map[string]string: Tags assigned to the domain.
VpcOptions []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 List<GetDomainAdvancedSecurityOption>: Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes:
arn String: The ARN of the domain.
autoTuneOptions List<GetDomainAutoTuneOption>: Configuration of the Auto-Tune options of the domain.
clusterConfigs List<GetDomainClusterConfig>: Cluster configuration of the domain.
cognitoOptions List<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 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 Boolean: Status of a configuration change in the domain.
snapshotOptions List<GetDomainSnapshotOption>: Domain snapshot related options.
tags Map<String,String>: Tags assigned to the domain.
vpcOptions List<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 ARN of the domain.
autoTuneOptions GetDomainAutoTuneOption[]: Configuration of the Auto-Tune options 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.
snapshotOptions GetDomainSnapshotOption[]: Domain snapshot related options.
tags {[key: string]: string}: 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 Mapping[str, str]: Key-value string pairs to specify advanced configuration options.
advanced_security_options Sequence[GetDomainAdvancedSecurityOption]: Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes:
arn str: The ARN of the domain.
auto_tune_options Sequence[GetDomainAutoTuneOption]: Configuration of the Auto-Tune options of the domain.
cluster_configs Sequence[GetDomainClusterConfig]: Cluster configuration of the domain.
cognito_options Sequence[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 Sequence[GetDomainEbsOption]: EBS Options for the instances in the domain.
elasticsearch_version str: Elasticsearch version for the domain.
encryption_at_rests Sequence[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 Sequence[GetDomainLogPublishingOption]: Domain log publishing related options.
node_to_node_encryptions Sequence[GetDomainNodeToNodeEncryption]: Domain in transit encryption related options.
processing bool: Status of a configuration change in the domain.
snapshot_options Sequence[GetDomainSnapshotOption]: Domain snapshot related options.
tags Mapping[str, str]: Tags assigned to the domain.
vpc_options Sequence[GetDomainVpcOption]: VPC Options for private Elasticsearch domains.

accessPolicies String: The policy document attached to the domain.
advancedOptions Map<String>: Key-value string pairs to specify advanced configuration options.
advancedSecurityOptions List<Property Map>: Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes:
arn String: The ARN of the domain.
autoTuneOptions List<Property Map>: Configuration of the Auto-Tune options of the domain.
clusterConfigs List<Property Map>: Cluster configuration of the domain.
cognitoOptions List<Property Map>: 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 List<Property Map>: EBS Options for the instances in the domain.
elasticsearchVersion String: Elasticsearch version for the domain.
encryptionAtRests List<Property Map>: 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<Property Map>: Domain log publishing related options.
nodeToNodeEncryptions List<Property Map>: Domain in transit encryption related options.
processing Boolean: Status of a configuration change in the domain.
snapshotOptions List<Property Map>: Domain snapshot related options.
tags Map<String>: Tags assigned to the domain.
vpcOptions List<Property Map>: 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 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.
internal_user_database_enabled 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.

GetDomainAutoTuneOption

DesiredState string: The Auto-Tune desired state for the domain.
MaintenanceSchedules List<GetDomainAutoTuneOptionMaintenanceSchedule>: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
RollbackOnDisable string: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

DesiredState string: The Auto-Tune desired state for the domain.
MaintenanceSchedules []GetDomainAutoTuneOptionMaintenanceSchedule: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
RollbackOnDisable string: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

desiredState String: The Auto-Tune desired state for the domain.
maintenanceSchedules List<GetDomainAutoTuneOptionMaintenanceSchedule>: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
rollbackOnDisable String: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

desiredState string: The Auto-Tune desired state for the domain.
maintenanceSchedules GetDomainAutoTuneOptionMaintenanceSchedule[]: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
rollbackOnDisable string: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

desired_state str: The Auto-Tune desired state for the domain.
maintenance_schedules Sequence[GetDomainAutoTuneOptionMaintenanceSchedule]: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
rollback_on_disable str: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

desiredState String: The Auto-Tune desired state for the domain.
maintenanceSchedules List<Property Map>: A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
rollbackOnDisable String: Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.

GetDomainAutoTuneOptionMaintenanceSchedule

CronExpressionForRecurrence string: Cron expression for an Auto-Tune maintenance schedule.
Durations List<GetDomainAutoTuneOptionMaintenanceScheduleDuration>: Configuration block for the duration of the Auto-Tune maintenance window.
StartAt string: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

CronExpressionForRecurrence string: Cron expression for an Auto-Tune maintenance schedule.
Durations []GetDomainAutoTuneOptionMaintenanceScheduleDuration: Configuration block for the duration of the Auto-Tune maintenance window.
StartAt string: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

cronExpressionForRecurrence String: Cron expression for an Auto-Tune maintenance schedule.
durations List<GetDomainAutoTuneOptionMaintenanceScheduleDuration>: Configuration block for the duration of the Auto-Tune maintenance window.
startAt String: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

cronExpressionForRecurrence string: Cron expression for an Auto-Tune maintenance schedule.
durations GetDomainAutoTuneOptionMaintenanceScheduleDuration[]: Configuration block for the duration of the Auto-Tune maintenance window.
startAt string: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

cron_expression_for_recurrence str: Cron expression for an Auto-Tune maintenance schedule.
durations Sequence[GetDomainAutoTuneOptionMaintenanceScheduleDuration]: Configuration block for the duration of the Auto-Tune maintenance window.
start_at str: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

cronExpressionForRecurrence String: Cron expression for an Auto-Tune maintenance schedule.
durations List<Property Map>: Configuration block for the duration of the Auto-Tune maintenance window.
startAt String: Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.

GetDomainAutoTuneOptionMaintenanceScheduleDuration

Unit string: Unit of time.
Value int: Duration of an Auto-Tune maintenance window.

Unit string: Unit of time.
Value int: Duration of an Auto-Tune maintenance window.

unit String: Unit of time.
value Integer: Duration of an Auto-Tune maintenance window.

unit string: Unit of time.
value number: Duration of an Auto-Tune maintenance window.

unit str: Unit of time.
value int: Duration of an Auto-Tune maintenance window.

unit String: Unit of time.
value Number: Duration of an Auto-Tune maintenance window.

GetDomainClusterConfig

ColdStorageOptions List<GetDomainClusterConfigColdStorageOption>: Configuration block containing cold storage configuration.
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.
WarmEnabled bool: Warm storage is enabled.
WarmType string: 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.

ColdStorageOptions []GetDomainClusterConfigColdStorageOption: Configuration block containing cold storage configuration.
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.
WarmEnabled bool: Warm storage is enabled.
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.

coldStorageOptions List<GetDomainClusterConfigColdStorageOption>: Configuration block containing cold storage configuration.
dedicatedMasterCount Integer: 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 Integer: Number of instances in the cluster.
instanceType String: Instance type of data nodes in the cluster.
warmCount Integer: The number of warm nodes in the cluster.
warmEnabled Boolean: Warm storage is enabled.
warmType String: The instance type for the Elasticsearch cluster's warm nodes.
zoneAwarenessConfigs List<GetDomainClusterConfigZoneAwarenessConfig>: Configuration block containing zone awareness settings.
zoneAwarenessEnabled Boolean: Indicates whether zone awareness is enabled.

coldStorageOptions GetDomainClusterConfigColdStorageOption[]: Configuration block containing cold storage configuration.
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.
warmEnabled boolean: Warm storage is enabled.
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.

cold_storage_options Sequence[GetDomainClusterConfigColdStorageOption]: Configuration block containing cold storage configuration.
dedicated_master_count int: Number of dedicated master nodes in the cluster.
dedicated_master_enabled bool: Indicates whether dedicated master nodes are enabled for the cluster.
dedicated_master_type str: Instance type of the dedicated master nodes in the cluster.
instance_count int: Number of instances in the cluster.
instance_type str: Instance type of data nodes in the cluster.
warm_count int: The number of warm nodes in the cluster.
warm_enabled bool: Warm storage is enabled.
warm_type str: The instance type for the Elasticsearch cluster's warm nodes.
zone_awareness_configs Sequence[GetDomainClusterConfigZoneAwarenessConfig]: Configuration block containing zone awareness settings.
zone_awareness_enabled bool: Indicates whether zone awareness is enabled.

coldStorageOptions List<Property Map>: Configuration block containing cold storage configuration.
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.
warmEnabled Boolean: Warm storage is enabled.
warmType String: The instance type for the Elasticsearch cluster's warm nodes.
zoneAwarenessConfigs List<Property Map>: Configuration block containing zone awareness settings.
zoneAwarenessEnabled Boolean: Indicates whether zone awareness is enabled.

GetDomainClusterConfigColdStorageOption

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 boolean: 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.

GetDomainClusterConfigZoneAwarenessConfig

AvailabilityZoneCount int: Number of availability zones used.

AvailabilityZoneCount int: Number of availability zones used.

availabilityZoneCount Integer: Number of availability zones used.

availabilityZoneCount number: Number of availability zones used.

availability_zone_count int: Number of availability zones used.

availabilityZoneCount Number: 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 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.

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.

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.
Throughput int: The throughput (in MiB/s) of the 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.
Throughput int: The throughput (in MiB/s) of the 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 Integer: The baseline input/output (I/O) performance of EBS volumes attached to data nodes.
throughput Integer: The throughput (in MiB/s) of the EBS volumes attached to data nodes.
volumeSize Integer: 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.
throughput number: The throughput (in MiB/s) of the 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.

ebs_enabled 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.
throughput int: The throughput (in MiB/s) of the EBS volumes attached to data nodes.
volume_size int: The size of EBS volumes attached to data nodes (in GB).
volume_type str: 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.
throughput Number: The throughput (in MiB/s) of the 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.

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 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.

enabled Boolean: Whether node to node encryption is enabled.
kmsKeyId String: 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.

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.
log_type str: 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.

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 boolean: 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.

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 Integer: 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.

automated_snapshot_start_hour 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.

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 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.

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

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.

Package Details

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

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

aws.elasticsearch.getDomain

On this page

On this page

Example Usage

Using getDomain

getDomain Result

Supporting Types

GetDomainAdvancedSecurityOption

GetDomainAutoTuneOption

GetDomainAutoTuneOptionMaintenanceSchedule

GetDomainAutoTuneOptionMaintenanceScheduleDuration

GetDomainClusterConfig

GetDomainClusterConfigColdStorageOption

GetDomainClusterConfigZoneAwarenessConfig

GetDomainCognitoOption

GetDomainEbsOption

GetDomainEncryptionAtRest

GetDomainLogPublishingOption

GetDomainNodeToNodeEncryption

GetDomainSnapshotOption

GetDomainVpcOption

Package Details

On this page

On this page