AWS v6.83.0, Jun 16 25

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

aws.opensearch.getDomain

Explore with Pulumi AI

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

Example Usage

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

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

import pulumi
import pulumi_aws as aws

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

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.LookupDomain(ctx, &opensearch.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.OpenSearch.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.opensearch.OpensearchFunctions;
import com.pulumi.aws.opensearch.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 = OpensearchFunctions.getDomain(GetDomainArgs.builder()
            .domainName("my-domain-name")
            .build());

    }
}

variables:
  myDomain:
    fn::invoke:
      function: aws:opensearch: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.

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

def get_domain(domain_name: Optional[str] = None,
               off_peak_window_options: Optional[GetDomainOffPeakWindowOptions] = None,
               tags: Optional[Mapping[str, str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               off_peak_window_options: Optional[pulumi.Input[GetDomainOffPeakWindowOptionsArgs]] = 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:opensearch/getDomain:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string: Name of the domain.
OffPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options
Tags Dictionary<string, string>: Tags assigned to the domain.

DomainName string: Name of the domain.
OffPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options
Tags map[string]string: Tags assigned to the domain.

domainName String: Name of the domain.
offPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options
tags Map<String,String>: Tags assigned to the domain.

domainName string: Name of the domain.
offPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options
tags {[key: string]: string}: Tags assigned to the domain.

domain_name str: Name of the domain.
off_peak_window_options GetDomainOffPeakWindowOptions: Off Peak update options
tags Mapping[str, str]: Tags assigned to the domain.

domainName String: Name of the domain.
offPeakWindowOptions Property Map: Off Peak update options
tags Map<String>: Tags assigned to the domain.

getDomain Result

The following output properties are available:

AccessPolicies string: 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 OpenSearch domain's advanced security options. The block consists of the following attributes:
Arn string: 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 Dashboard.
Created bool: Status of the creation of the domain.
DashboardEndpoint string: Domain-specific endpoint used to access the Dashboard application.
DashboardEndpointV2 string: V2 domain-specific endpoint used to access the Dashboard application
Deleted bool: Status of the deletion of the domain.
DomainEndpointV2HostedZoneId string: Dual stack hosted zone ID for the domain.
DomainId string: Unique identifier for the domain.
DomainName string
EbsOptions List<GetDomainEbsOption>: EBS Options for the instances in 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.
EndpointV2 string: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
EngineVersion string: OpenSearch version for the domain.
Id string: The provider-assigned unique ID for this managed resource.
IpAddressType string: Type of IP addresses supported by the endpoint for the domain.
KibanaEndpoint string: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
SoftwareUpdateOptions List<GetDomainSoftwareUpdateOption>: Software update options for the domain
Tags Dictionary<string, string>: Tags assigned to the domain.
VpcOptions List<GetDomainVpcOption>: VPC Options for private OpenSearch domains.
OffPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options

AccessPolicies string: Policy document attached to the domain.
AdvancedOptions map[string]string: Key-value string pairs to specify advanced configuration options.
AdvancedSecurityOptions []GetDomainAdvancedSecurityOption: Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
Arn string: 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 Dashboard.
Created bool: Status of the creation of the domain.
DashboardEndpoint string: Domain-specific endpoint used to access the Dashboard application.
DashboardEndpointV2 string: V2 domain-specific endpoint used to access the Dashboard application
Deleted bool: Status of the deletion of the domain.
DomainEndpointV2HostedZoneId string: Dual stack hosted zone ID for the domain.
DomainId string: Unique identifier for the domain.
DomainName string
EbsOptions []GetDomainEbsOption: EBS Options for the instances in the domain.
EncryptionAtRests []GetDomainEncryptionAtRest: Domain encryption at rest related options.
Endpoint string: Domain-specific endpoint used to submit index, search, and data upload requests.
EndpointV2 string: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
EngineVersion string: OpenSearch version for the domain.
Id string: The provider-assigned unique ID for this managed resource.
IpAddressType string: Type of IP addresses supported by the endpoint for the domain.
KibanaEndpoint string: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
SoftwareUpdateOptions []GetDomainSoftwareUpdateOption: Software update options for the domain
Tags map[string]string: Tags assigned to the domain.
VpcOptions []GetDomainVpcOption: VPC Options for private OpenSearch domains.
OffPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options

accessPolicies String: 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 OpenSearch domain's advanced security options. The block consists of the following attributes:
arn String: 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 Dashboard.
created Boolean: Status of the creation of the domain.
dashboardEndpoint String: Domain-specific endpoint used to access the Dashboard application.
dashboardEndpointV2 String: V2 domain-specific endpoint used to access the Dashboard application
deleted Boolean: Status of the deletion of the domain.
domainEndpointV2HostedZoneId String: Dual stack hosted zone ID for the domain.
domainId String: Unique identifier for the domain.
domainName String
ebsOptions List<GetDomainEbsOption>: EBS Options for the instances in 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.
endpointV2 String: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
engineVersion String: OpenSearch version for the domain.
id String: The provider-assigned unique ID for this managed resource.
ipAddressType String: Type of IP addresses supported by the endpoint for the domain.
kibanaEndpoint String: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
softwareUpdateOptions List<GetDomainSoftwareUpdateOption>: Software update options for the domain
tags Map<String,String>: Tags assigned to the domain.
vpcOptions List<GetDomainVpcOption>: VPC Options for private OpenSearch domains.
offPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options

accessPolicies string: Policy document attached to the domain.
advancedOptions {[key: string]: string}: Key-value string pairs to specify advanced configuration options.
advancedSecurityOptions GetDomainAdvancedSecurityOption[]: Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
arn string: 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 Dashboard.
created boolean: Status of the creation of the domain.
dashboardEndpoint string: Domain-specific endpoint used to access the Dashboard application.
dashboardEndpointV2 string: V2 domain-specific endpoint used to access the Dashboard application
deleted boolean: Status of the deletion of the domain.
domainEndpointV2HostedZoneId string: Dual stack hosted zone ID for the domain.
domainId string: Unique identifier for the domain.
domainName string
ebsOptions GetDomainEbsOption[]: EBS Options for the instances in the domain.
encryptionAtRests GetDomainEncryptionAtRest[]: Domain encryption at rest related options.
endpoint string: Domain-specific endpoint used to submit index, search, and data upload requests.
endpointV2 string: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
engineVersion string: OpenSearch version for the domain.
id string: The provider-assigned unique ID for this managed resource.
ipAddressType string: Type of IP addresses supported by the endpoint for the domain.
kibanaEndpoint string: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
softwareUpdateOptions GetDomainSoftwareUpdateOption[]: Software update options for the domain
tags {[key: string]: string}: Tags assigned to the domain.
vpcOptions GetDomainVpcOption[]: VPC Options for private OpenSearch domains.
offPeakWindowOptions GetDomainOffPeakWindowOptions: Off Peak update options

access_policies str: 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 OpenSearch domain's advanced security options. The block consists of the following attributes:
arn str: 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 Dashboard.
created bool: Status of the creation of the domain.
dashboard_endpoint str: Domain-specific endpoint used to access the Dashboard application.
dashboard_endpoint_v2 str: V2 domain-specific endpoint used to access the Dashboard application
deleted bool: Status of the deletion of the domain.
domain_endpoint_v2_hosted_zone_id str: Dual stack hosted zone ID for 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.
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.
endpoint_v2 str: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
engine_version str: OpenSearch version for the domain.
id str: The provider-assigned unique ID for this managed resource.
ip_address_type str: Type of IP addresses supported by the endpoint for the domain.
kibana_endpoint str: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
software_update_options Sequence[GetDomainSoftwareUpdateOption]: Software update options for the domain
tags Mapping[str, str]: Tags assigned to the domain.
vpc_options Sequence[GetDomainVpcOption]: VPC Options for private OpenSearch domains.
off_peak_window_options GetDomainOffPeakWindowOptions: Off Peak update options

accessPolicies String: 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 OpenSearch domain's advanced security options. The block consists of the following attributes:
arn String: 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 Dashboard.
created Boolean: Status of the creation of the domain.
dashboardEndpoint String: Domain-specific endpoint used to access the Dashboard application.
dashboardEndpointV2 String: V2 domain-specific endpoint used to access the Dashboard application
deleted Boolean: Status of the deletion of the domain.
domainEndpointV2HostedZoneId String: Dual stack hosted zone ID for the domain.
domainId String: Unique identifier for the domain.
domainName String
ebsOptions List<Property Map>: EBS Options for the instances in 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.
endpointV2 String: V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
engineVersion String: OpenSearch version for the domain.
id String: The provider-assigned unique ID for this managed resource.
ipAddressType String: Type of IP addresses supported by the endpoint for the domain.
kibanaEndpoint String: (Deprecated) Domain-specific endpoint for kibana without https scheme. Use the dashboard_endpoint attribute instead.
Deprecated: kibana_endpoint is deprecated. Use dashboard_endpoint instead.
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.
softwareUpdateOptions List<Property Map>: Software update options for the domain
tags Map<String>: Tags assigned to the domain.
vpcOptions List<Property Map>: VPC Options for private OpenSearch domains.
offPeakWindowOptions Property Map: Off Peak update options

Supporting Types

GetDomainAdvancedSecurityOption

AnonymousAuthEnabled bool
Enabled bool: Enabled disabled toggle for off-peak update window
InternalUserDatabaseEnabled bool: Whether the internal user database is enabled.

AnonymousAuthEnabled bool
Enabled bool: Enabled disabled toggle for off-peak update window
InternalUserDatabaseEnabled bool: Whether the internal user database is enabled.

anonymousAuthEnabled Boolean
enabled Boolean: Enabled disabled toggle for off-peak update window
internalUserDatabaseEnabled Boolean: Whether the internal user database is enabled.

anonymousAuthEnabled boolean
enabled boolean: Enabled disabled toggle for off-peak update window
internalUserDatabaseEnabled boolean: Whether the internal user database is enabled.

anonymous_auth_enabled bool
enabled bool: Enabled disabled toggle for off-peak update window
internal_user_database_enabled bool: Whether the internal user database is enabled.

anonymousAuthEnabled Boolean
enabled Boolean: Enabled disabled toggle for off-peak update window
internalUserDatabaseEnabled Boolean: Whether the internal user database is enabled.

GetDomainAutoTuneOption

DesiredState string: 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.
UseOffPeakWindow bool: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

DesiredState string: 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.
UseOffPeakWindow bool: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

desiredState String: 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.
useOffPeakWindow Boolean: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

desiredState string: 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.
useOffPeakWindow boolean: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

desired_state str: 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.
use_off_peak_window bool: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

desiredState String: 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.
useOffPeakWindow Boolean: Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

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.
MultiAzWithStandbyEnabled bool: Whether a multi-AZ domain is turned on with a standby AZ.
NodeOptions List<GetDomainClusterConfigNodeOption>: List of node options for the domain.
WarmCount int: Number of warm nodes in the cluster.
WarmType string: Instance type for the OpenSearch cluster's warm nodes.
ZoneAwarenessConfigs List<GetDomainClusterConfigZoneAwarenessConfig>: Configuration block containing zone awareness settings.
ZoneAwarenessEnabled bool: Indicates whether zone awareness is enabled.
WarmEnabled bool: Warm storage 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.
MultiAzWithStandbyEnabled bool: Whether a multi-AZ domain is turned on with a standby AZ.
NodeOptions []GetDomainClusterConfigNodeOption: List of node options for the domain.
WarmCount int: Number of warm nodes in the cluster.
WarmType string: Instance type for the OpenSearch cluster's warm nodes.
ZoneAwarenessConfigs []GetDomainClusterConfigZoneAwarenessConfig: Configuration block containing zone awareness settings.
ZoneAwarenessEnabled bool: Indicates whether zone awareness is enabled.
WarmEnabled bool: Warm storage 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.
multiAzWithStandbyEnabled Boolean: Whether a multi-AZ domain is turned on with a standby AZ.
nodeOptions List<GetDomainClusterConfigNodeOption>: List of node options for the domain.
warmCount Integer: Number of warm nodes in the cluster.
warmType String: Instance type for the OpenSearch cluster's warm nodes.
zoneAwarenessConfigs List<GetDomainClusterConfigZoneAwarenessConfig>: Configuration block containing zone awareness settings.
zoneAwarenessEnabled Boolean: Indicates whether zone awareness is enabled.
warmEnabled Boolean: Warm storage 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.
multiAzWithStandbyEnabled boolean: Whether a multi-AZ domain is turned on with a standby AZ.
nodeOptions GetDomainClusterConfigNodeOption[]: List of node options for the domain.
warmCount number: Number of warm nodes in the cluster.
warmType string: Instance type for the OpenSearch cluster's warm nodes.
zoneAwarenessConfigs GetDomainClusterConfigZoneAwarenessConfig[]: Configuration block containing zone awareness settings.
zoneAwarenessEnabled boolean: Indicates whether zone awareness is enabled.
warmEnabled boolean: Warm storage 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.
multi_az_with_standby_enabled bool: Whether a multi-AZ domain is turned on with a standby AZ.
node_options Sequence[GetDomainClusterConfigNodeOption]: List of node options for the domain.
warm_count int: Number of warm nodes in the cluster.
warm_type str: Instance type for the OpenSearch 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.
warm_enabled bool: Warm storage 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.
multiAzWithStandbyEnabled Boolean: Whether a multi-AZ domain is turned on with a standby AZ.
nodeOptions List<Property Map>: List of node options for the domain.
warmCount Number: Number of warm nodes in the cluster.
warmType String: Instance type for the OpenSearch cluster's warm nodes.
zoneAwarenessConfigs List<Property Map>: Configuration block containing zone awareness settings.
zoneAwarenessEnabled Boolean: Indicates whether zone awareness is enabled.
warmEnabled Boolean: Warm storage is enabled.

GetDomainClusterConfigColdStorageOption

Enabled bool: Enabled disabled toggle for off-peak update window

Enabled bool: Enabled disabled toggle for off-peak update window

enabled Boolean: Enabled disabled toggle for off-peak update window

enabled boolean: Enabled disabled toggle for off-peak update window

enabled bool: Enabled disabled toggle for off-peak update window

enabled Boolean: Enabled disabled toggle for off-peak update window

GetDomainClusterConfigNodeOption

NodeConfigs List<GetDomainClusterConfigNodeOptionNodeConfig>: Sizing of a node type.
NodeType string: Type of node this configuration describes.

NodeConfigs []GetDomainClusterConfigNodeOptionNodeConfig: Sizing of a node type.
NodeType string: Type of node this configuration describes.

nodeConfigs List<GetDomainClusterConfigNodeOptionNodeConfig>: Sizing of a node type.
nodeType String: Type of node this configuration describes.

nodeConfigs GetDomainClusterConfigNodeOptionNodeConfig[]: Sizing of a node type.
nodeType string: Type of node this configuration describes.

node_configs Sequence[GetDomainClusterConfigNodeOptionNodeConfig]: Sizing of a node type.
node_type str: Type of node this configuration describes.

nodeConfigs List<Property Map>: Sizing of a node type.
nodeType String: Type of node this configuration describes.

GetDomainClusterConfigNodeOptionNodeConfig

Count int: Number of nodes of a particular node type in the cluster.
Enabled bool: Enabled disabled toggle for off-peak update window
Type string: The instance type of a particular node type in the cluster.

Count int: Number of nodes of a particular node type in the cluster.
Enabled bool: Enabled disabled toggle for off-peak update window
Type string: The instance type of a particular node type in the cluster.

count Integer: Number of nodes of a particular node type in the cluster.
enabled Boolean: Enabled disabled toggle for off-peak update window
type String: The instance type of a particular node type in the cluster.

count number: Number of nodes of a particular node type in the cluster.
enabled boolean: Enabled disabled toggle for off-peak update window
type string: The instance type of a particular node type in the cluster.

count int: Number of nodes of a particular node type in the cluster.
enabled bool: Enabled disabled toggle for off-peak update window
type str: The instance type of a particular node type in the cluster.

count Number: Number of nodes of a particular node type in the cluster.
enabled Boolean: Enabled disabled toggle for off-peak update window
type String: The instance type of a particular node type in the cluster.

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: Enabled disabled toggle for off-peak update window
IdentityPoolId string: Cognito Identity pool used by the domain.
RoleArn string: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
UserPoolId string: Cognito User pool used by the domain.

Enabled bool: Enabled disabled toggle for off-peak update window
IdentityPoolId string: Cognito Identity pool used by the domain.
RoleArn string: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
UserPoolId string: Cognito User pool used by the domain.

enabled Boolean: Enabled disabled toggle for off-peak update window
identityPoolId String: Cognito Identity pool used by the domain.
roleArn String: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
userPoolId String: Cognito User pool used by the domain.

enabled boolean: Enabled disabled toggle for off-peak update window
identityPoolId string: Cognito Identity pool used by the domain.
roleArn string: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
userPoolId string: Cognito User pool used by the domain.

enabled bool: Enabled disabled toggle for off-peak update window
identity_pool_id str: Cognito Identity pool used by the domain.
role_arn str: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
user_pool_id str: Cognito User pool used by the domain.

enabled Boolean: Enabled disabled toggle for off-peak update window
identityPoolId String: Cognito Identity pool used by the domain.
roleArn String: IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
userPoolId String: Cognito User pool used by the domain.

GetDomainEbsOption

EbsEnabled bool: Whether EBS volumes are attached to data nodes in the domain.
Iops int: 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: Size of EBS volumes attached to data nodes (in GB).
VolumeType string: Type of EBS volumes attached to data nodes.

EbsEnabled bool: Whether EBS volumes are attached to data nodes in the domain.
Iops int: 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: Size of EBS volumes attached to data nodes (in GB).
VolumeType string: Type of EBS volumes attached to data nodes.

ebsEnabled Boolean: Whether EBS volumes are attached to data nodes in the domain.
iops Integer: 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: Size of EBS volumes attached to data nodes (in GB).
volumeType String: Type of EBS volumes attached to data nodes.

ebsEnabled boolean: Whether EBS volumes are attached to data nodes in the domain.
iops number: 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: Size of EBS volumes attached to data nodes (in GB).
volumeType string: Type of EBS volumes attached to data nodes.

ebs_enabled bool: Whether EBS volumes are attached to data nodes in the domain.
iops int: 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: Size of EBS volumes attached to data nodes (in GB).
volume_type str: Type of EBS volumes attached to data nodes.

ebsEnabled Boolean: Whether EBS volumes are attached to data nodes in the domain.
iops Number: 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: Size of EBS volumes attached to data nodes (in GB).
volumeType String: Type of EBS volumes attached to data nodes.

GetDomainEncryptionAtRest

Enabled bool: Enabled disabled toggle for off-peak update window
KmsKeyId string: KMS key id used to encrypt data at rest.

Enabled bool: Enabled disabled toggle for off-peak update window
KmsKeyId string: KMS key id used to encrypt data at rest.

enabled Boolean: Enabled disabled toggle for off-peak update window
kmsKeyId String: KMS key id used to encrypt data at rest.

enabled boolean: Enabled disabled toggle for off-peak update window
kmsKeyId string: KMS key id used to encrypt data at rest.

enabled bool: Enabled disabled toggle for off-peak update window
kms_key_id str: KMS key id used to encrypt data at rest.

enabled Boolean: Enabled disabled toggle for off-peak update window
kmsKeyId String: KMS key id used to encrypt data at rest.

GetDomainLogPublishingOption

CloudwatchLogGroupArn string: CloudWatch Log Group where the logs are published.
Enabled bool: Enabled disabled toggle for off-peak update window
LogType string: Type of OpenSearch log being published.

CloudwatchLogGroupArn string: CloudWatch Log Group where the logs are published.
Enabled bool: Enabled disabled toggle for off-peak update window
LogType string: Type of OpenSearch log being published.

cloudwatchLogGroupArn String: CloudWatch Log Group where the logs are published.
enabled Boolean: Enabled disabled toggle for off-peak update window
logType String: Type of OpenSearch log being published.

cloudwatchLogGroupArn string: CloudWatch Log Group where the logs are published.
enabled boolean: Enabled disabled toggle for off-peak update window
logType string: Type of OpenSearch log being published.

cloudwatch_log_group_arn str: CloudWatch Log Group where the logs are published.
enabled bool: Enabled disabled toggle for off-peak update window
log_type str: Type of OpenSearch log being published.

cloudwatchLogGroupArn String: CloudWatch Log Group where the logs are published.
enabled Boolean: Enabled disabled toggle for off-peak update window
logType String: Type of OpenSearch log being published.