Try AWS Native preview for resources not in the classic version.
aws.opensearch.getDomain
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Use this data source to get information about an OpenSearch Domain
Example Usage
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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
})
}
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());
}
}
import pulumi
import pulumi_aws as aws
my_domain = aws.opensearch.get_domain(domain_name="my-domain-name")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myDomain = aws.opensearch.getDomain({
domainName: "my-domain-name",
});
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,
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:opensearch/getDomain:getDomain
arguments:
# arguments dictionary
The following arguments are supported:
- Domain
Name string Name of the domain.
- Dictionary<string, string>
Tags assigned to the domain.
- Domain
Name string Name of the domain.
- map[string]string
Tags assigned to the domain.
- domain
Name String Name of the domain.
- Map<String,String>
Tags assigned to the domain.
- domain
Name string Name of the domain.
- {[key: string]: string}
Tags assigned to the domain.
- domain_
name str Name of the domain.
- Mapping[str, str]
Tags assigned to the domain.
- domain
Name String Name of the domain.
- Map<String>
Tags assigned to the domain.
getDomain Result
The following output properties are available:
- Access
Policies string Policy document attached to the domain.
- Advanced
Options Dictionary<string, string> Key-value string pairs to specify advanced configuration options.
- Advanced
Security List<GetOptions Domain Advanced Security Option> Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- Arn string
ARN of the domain.
- Auto
Tune List<GetOptions Domain Auto Tune Option> Configuration of the Auto-Tune options of the domain.
- Cluster
Configs List<GetDomain Cluster Config> Cluster configuration of the domain.
- Cognito
Options List<GetDomain Cognito Option> Domain Amazon Cognito Authentication options for Dashboard.
- Created bool
Status of the creation of the domain.
- Dashboard
Endpoint string Domain-specific endpoint used to access the Dashboard application.
- Deleted bool
Status of the deletion of the domain.
- Domain
Id string Unique identifier for the domain.
- Domain
Name string - Ebs
Options List<GetDomain Ebs Option> EBS Options for the instances in the domain.
- Encryption
At List<GetRests Domain Encryption At Rest> Domain encryption at rest related options.
- Endpoint string
Domain-specific endpoint used to submit index, search, and data upload requests.
- Engine
Version string OpenSearch version for the domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Kibana
Endpoint string Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- Log
Publishing List<GetOptions Domain Log Publishing Option> Domain log publishing related options.
- Node
To List<GetNode Encryptions Domain Node To Node Encryption> Domain in transit encryption related options.
- Processing bool
Status of a configuration change in the domain.
- Snapshot
Options List<GetDomain Snapshot Option> Domain snapshot related options.
- Dictionary<string, string>
Tags assigned to the domain.
- Vpc
Options List<GetDomain Vpc Option> VPC Options for private OpenSearch domains.
- Access
Policies string Policy document attached to the domain.
- Advanced
Options map[string]string Key-value string pairs to specify advanced configuration options.
- Advanced
Security []GetOptions Domain Advanced Security Option Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- Arn string
ARN of the domain.
- Auto
Tune []GetOptions Domain Auto Tune Option Configuration of the Auto-Tune options of the domain.
- Cluster
Configs []GetDomain Cluster Config Cluster configuration of the domain.
- Cognito
Options []GetDomain Cognito Option Domain Amazon Cognito Authentication options for Dashboard.
- Created bool
Status of the creation of the domain.
- Dashboard
Endpoint string Domain-specific endpoint used to access the Dashboard application.
- Deleted bool
Status of the deletion of the domain.
- Domain
Id string Unique identifier for the domain.
- Domain
Name string - Ebs
Options []GetDomain Ebs Option EBS Options for the instances in the domain.
- Encryption
At []GetRests Domain Encryption At Rest Domain encryption at rest related options.
- Endpoint string
Domain-specific endpoint used to submit index, search, and data upload requests.
- Engine
Version string OpenSearch version for the domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Kibana
Endpoint string Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- Log
Publishing []GetOptions Domain Log Publishing Option Domain log publishing related options.
- Node
To []GetNode Encryptions Domain Node To Node Encryption Domain in transit encryption related options.
- Processing bool
Status of a configuration change in the domain.
- Snapshot
Options []GetDomain Snapshot Option Domain snapshot related options.
- map[string]string
Tags assigned to the domain.
- Vpc
Options []GetDomain Vpc Option VPC Options for private OpenSearch domains.
- access
Policies String Policy document attached to the domain.
- advanced
Options Map<String,String> Key-value string pairs to specify advanced configuration options.
- advanced
Security List<GetOptions Domain Advanced Security Option> Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- arn String
ARN of the domain.
- auto
Tune List<GetOptions Domain Auto Tune Option> Configuration of the Auto-Tune options of the domain.
- cluster
Configs List<GetDomain Cluster Config> Cluster configuration of the domain.
- cognito
Options List<GetDomain Cognito Option> Domain Amazon Cognito Authentication options for Dashboard.
- created Boolean
Status of the creation of the domain.
- dashboard
Endpoint String Domain-specific endpoint used to access the Dashboard application.
- deleted Boolean
Status of the deletion of the domain.
- domain
Id String Unique identifier for the domain.
- domain
Name String - ebs
Options List<GetDomain Ebs Option> EBS Options for the instances in the domain.
- encryption
At List<GetRests Domain Encryption At Rest> Domain encryption at rest related options.
- endpoint String
Domain-specific endpoint used to submit index, search, and data upload requests.
- engine
Version String OpenSearch version for the domain.
- id String
The provider-assigned unique ID for this managed resource.
- kibana
Endpoint String Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- log
Publishing List<GetOptions Domain Log Publishing Option> Domain log publishing related options.
- node
To List<GetNode Encryptions Domain Node To Node Encryption> Domain in transit encryption related options.
- processing Boolean
Status of a configuration change in the domain.
- snapshot
Options List<GetDomain Snapshot Option> Domain snapshot related options.
- Map<String,String>
Tags assigned to the domain.
- vpc
Options List<GetDomain Vpc Option> VPC Options for private OpenSearch domains.
- access
Policies string Policy document attached to the domain.
- advanced
Options {[key: string]: string} Key-value string pairs to specify advanced configuration options.
- advanced
Security GetOptions Domain Advanced Security Option[] Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- arn string
ARN of the domain.
- auto
Tune GetOptions Domain Auto Tune Option[] Configuration of the Auto-Tune options of the domain.
- cluster
Configs GetDomain Cluster Config[] Cluster configuration of the domain.
- cognito
Options GetDomain Cognito Option[] Domain Amazon Cognito Authentication options for Dashboard.
- created boolean
Status of the creation of the domain.
- dashboard
Endpoint string Domain-specific endpoint used to access the Dashboard application.
- deleted boolean
Status of the deletion of the domain.
- domain
Id string Unique identifier for the domain.
- domain
Name string - ebs
Options GetDomain Ebs Option[] EBS Options for the instances in the domain.
- encryption
At GetRests Domain Encryption At Rest[] Domain encryption at rest related options.
- endpoint string
Domain-specific endpoint used to submit index, search, and data upload requests.
- engine
Version string OpenSearch version for the domain.
- id string
The provider-assigned unique ID for this managed resource.
- kibana
Endpoint string Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- log
Publishing GetOptions Domain Log Publishing Option[] Domain log publishing related options.
- node
To GetNode Encryptions Domain Node To Node Encryption[] Domain in transit encryption related options.
- processing boolean
Status of a configuration change in the domain.
- snapshot
Options GetDomain Snapshot Option[] Domain snapshot related options.
- {[key: string]: string}
Tags assigned to the domain.
- vpc
Options GetDomain Vpc Option[] VPC Options for private OpenSearch domains.
- 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_ Sequence[Getoptions Domain Advanced Security Option] Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- arn str
ARN of the domain.
- auto_
tune_ Sequence[Getoptions Domain Auto Tune Option] Configuration of the Auto-Tune options of the domain.
- cluster_
configs Sequence[GetDomain Cluster Config] Cluster configuration of the domain.
- cognito_
options Sequence[GetDomain Cognito Option] 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.
- deleted bool
Status of the deletion of the domain.
- domain_
id str Unique identifier for the domain.
- domain_
name str - ebs_
options Sequence[GetDomain Ebs Option] EBS Options for the instances in the domain.
- encryption_
at_ Sequence[Getrests Domain Encryption At Rest] Domain encryption at rest related options.
- endpoint str
Domain-specific endpoint 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.
- kibana_
endpoint str Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- log_
publishing_ Sequence[Getoptions Domain Log Publishing Option] Domain log publishing related options.
- node_
to_ Sequence[Getnode_ encryptions Domain Node To Node Encryption] Domain in transit encryption related options.
- processing bool
Status of a configuration change in the domain.
- snapshot_
options Sequence[GetDomain Snapshot Option] Domain snapshot related options.
- Mapping[str, str]
Tags assigned to the domain.
- vpc_
options Sequence[GetDomain Vpc Option] VPC Options for private OpenSearch domains.
- access
Policies String Policy document attached to the domain.
- advanced
Options Map<String> Key-value string pairs to specify advanced configuration options.
- advanced
Security List<Property Map>Options Status of the OpenSearch domain's advanced security options. The block consists of the following attributes:
- arn String
ARN of the domain.
- auto
Tune List<Property Map>Options Configuration of the Auto-Tune options of the domain.
- cluster
Configs List<Property Map> Cluster configuration of the domain.
- cognito
Options List<Property Map> Domain Amazon Cognito Authentication options for Dashboard.
- created Boolean
Status of the creation of the domain.
- dashboard
Endpoint String Domain-specific endpoint used to access the Dashboard application.
- deleted Boolean
Status of the deletion of the domain.
- domain
Id String Unique identifier for the domain.
- domain
Name String - ebs
Options List<Property Map> EBS Options for the instances in the domain.
- encryption
At List<Property Map>Rests Domain encryption at rest related options.
- endpoint String
Domain-specific endpoint used to submit index, search, and data upload requests.
- engine
Version String OpenSearch version for the domain.
- id String
The provider-assigned unique ID for this managed resource.
- kibana
Endpoint String Domain-specific endpoint used to access the Kibana application. OpenSearch Dashboards do not use Kibana, so this attribute will be DEPRECATED in a future version.
- log
Publishing List<Property Map>Options Domain log publishing related options.
- node
To List<Property Map>Node Encryptions Domain in transit encryption related options.
- processing Boolean
Status of a configuration change in the domain.
- snapshot
Options List<Property Map> Domain snapshot related options.
- Map<String>
Tags assigned to the domain.
- vpc
Options List<Property Map> VPC Options for private OpenSearch domains.
Supporting Types
GetDomainAdvancedSecurityOption
- Anonymous
Auth boolEnabled - Enabled bool
Whether node to node encryption is enabled.
- Internal
User boolDatabase Enabled Whether the internal user database is enabled.
- Anonymous
Auth boolEnabled - Enabled bool
Whether node to node encryption is enabled.
- Internal
User boolDatabase Enabled Whether the internal user database is enabled.
- anonymous
Auth BooleanEnabled - enabled Boolean
Whether node to node encryption is enabled.
- internal
User BooleanDatabase Enabled Whether the internal user database is enabled.
- anonymous
Auth booleanEnabled - enabled boolean
Whether node to node encryption is enabled.
- internal
User booleanDatabase Enabled Whether the internal user database is enabled.
- anonymous_
auth_ boolenabled - enabled bool
Whether node to node encryption is enabled.
- internal_
user_ booldatabase_ enabled Whether the internal user database is enabled.
- anonymous
Auth BooleanEnabled - enabled Boolean
Whether node to node encryption is enabled.
- internal
User BooleanDatabase Enabled Whether the internal user database is enabled.
GetDomainAutoTuneOption
- Desired
State string Auto-Tune desired state for the domain.
- Maintenance
Schedules List<GetDomain Auto Tune Option Maintenance Schedule> A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- Rollback
On stringDisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
- Desired
State string Auto-Tune desired state for the domain.
- Maintenance
Schedules []GetDomain Auto Tune Option Maintenance Schedule A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- Rollback
On stringDisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
- desired
State String Auto-Tune desired state for the domain.
- maintenance
Schedules List<GetDomain Auto Tune Option Maintenance Schedule> A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- rollback
On StringDisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
- desired
State string Auto-Tune desired state for the domain.
- maintenance
Schedules GetDomain Auto Tune Option Maintenance Schedule[] A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- rollback
On stringDisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
- desired_
state str Auto-Tune desired state for the domain.
- maintenance_
schedules Sequence[GetDomain Auto Tune Option Maintenance Schedule] A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- rollback_
on_ strdisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
- desired
State String Auto-Tune desired state for the domain.
- maintenance
Schedules List<Property Map> A list of the nested configurations for the Auto-Tune maintenance windows of the domain.
- rollback
On StringDisable Whether the domain is set to roll back to default Auto-Tune settings when disabling Auto-Tune.
GetDomainAutoTuneOptionMaintenanceSchedule
- Cron
Expression stringFor Recurrence Cron expression for an Auto-Tune maintenance schedule.
- Durations
List<Get
Domain Auto Tune Option Maintenance Schedule Duration> Configuration block for the duration of the Auto-Tune maintenance window.
- Start
At string Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.
- Cron
Expression stringFor Recurrence Cron expression for an Auto-Tune maintenance schedule.
- Durations
[]Get
Domain Auto Tune Option Maintenance Schedule Duration Configuration block for the duration of the Auto-Tune maintenance window.
- Start
At string Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.
- cron
Expression StringFor Recurrence Cron expression for an Auto-Tune maintenance schedule.
- durations
List<Get
Domain Auto Tune Option Maintenance Schedule Duration> Configuration block for the duration of the Auto-Tune maintenance window.
- start
At String Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.
- cron
Expression stringFor Recurrence Cron expression for an Auto-Tune maintenance schedule.
- durations
Get
Domain Auto Tune Option Maintenance Schedule Duration[] Configuration block for the duration of the Auto-Tune maintenance window.
- start
At string Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.
- cron_
expression_ strfor_ recurrence Cron expression for an Auto-Tune maintenance schedule.
- durations
Sequence[Get
Domain Auto Tune Option Maintenance Schedule Duration] 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.
- cron
Expression StringFor Recurrence Cron expression for an Auto-Tune maintenance schedule.
- durations List<Property Map>
Configuration block for the duration of the Auto-Tune maintenance window.
- start
At String Date and time at which the Auto-Tune maintenance schedule starts in RFC3339 format.
GetDomainAutoTuneOptionMaintenanceScheduleDuration
GetDomainClusterConfig
- Cold
Storage List<GetOptions Domain Cluster Config Cold Storage Option> Configuration block containing cold storage configuration.
- Dedicated
Master intCount Number of dedicated master nodes in the cluster.
- Dedicated
Master boolEnabled Indicates whether dedicated master nodes are enabled for the cluster.
- Dedicated
Master stringType Instance type of the dedicated master nodes in the cluster.
- Instance
Count int Number of instances in the cluster.
- Instance
Type string Instance type of data nodes in the cluster.
- Warm
Count int Number of warm nodes in the cluster.
- Warm
Type string Instance type for the OpenSearch cluster's warm nodes.
- Zone
Awareness List<GetConfigs Domain Cluster Config Zone Awareness Config> Configuration block containing zone awareness settings.
- Zone
Awareness boolEnabled Indicates whether zone awareness is enabled.
- Warm
Enabled bool Warm storage is enabled.
- Cold
Storage []GetOptions Domain Cluster Config Cold Storage Option Configuration block containing cold storage configuration.
- Dedicated
Master intCount Number of dedicated master nodes in the cluster.
- Dedicated
Master boolEnabled Indicates whether dedicated master nodes are enabled for the cluster.
- Dedicated
Master stringType Instance type of the dedicated master nodes in the cluster.
- Instance
Count int Number of instances in the cluster.
- Instance
Type string Instance type of data nodes in the cluster.
- Warm
Count int Number of warm nodes in the cluster.
- Warm
Type string Instance type for the OpenSearch cluster's warm nodes.
- Zone
Awareness []GetConfigs Domain Cluster Config Zone Awareness Config Configuration block containing zone awareness settings.
- Zone
Awareness boolEnabled Indicates whether zone awareness is enabled.
- Warm
Enabled bool Warm storage is enabled.
- cold
Storage List<GetOptions Domain Cluster Config Cold Storage Option> Configuration block containing cold storage configuration.
- dedicated
Master IntegerCount Number of dedicated master nodes in the cluster.
- dedicated
Master BooleanEnabled Indicates whether dedicated master nodes are enabled for the cluster.
- dedicated
Master StringType Instance type of the dedicated master nodes in the cluster.
- instance
Count Integer Number of instances in the cluster.
- instance
Type String Instance type of data nodes in the cluster.
- warm
Count Integer Number of warm nodes in the cluster.
- warm
Type String Instance type for the OpenSearch cluster's warm nodes.
- zone
Awareness List<GetConfigs Domain Cluster Config Zone Awareness Config> Configuration block containing zone awareness settings.
- zone
Awareness BooleanEnabled Indicates whether zone awareness is enabled.
- warm
Enabled Boolean Warm storage is enabled.
- cold
Storage GetOptions Domain Cluster Config Cold Storage Option[] Configuration block containing cold storage configuration.
- dedicated
Master numberCount Number of dedicated master nodes in the cluster.
- dedicated
Master booleanEnabled Indicates whether dedicated master nodes are enabled for the cluster.
- dedicated
Master stringType Instance type of the dedicated master nodes in the cluster.
- instance
Count number Number of instances in the cluster.
- instance
Type string Instance type of data nodes in the cluster.
- warm
Count number Number of warm nodes in the cluster.
- warm
Type string Instance type for the OpenSearch cluster's warm nodes.
- zone
Awareness GetConfigs Domain Cluster Config Zone Awareness Config[] Configuration block containing zone awareness settings.
- zone
Awareness booleanEnabled Indicates whether zone awareness is enabled.
- warm
Enabled boolean Warm storage is enabled.
- cold_
storage_ Sequence[Getoptions Domain Cluster Config Cold Storage Option] Configuration block containing cold storage configuration.
- dedicated_
master_ intcount Number of dedicated master nodes in the cluster.
- dedicated_
master_ boolenabled Indicates whether dedicated master nodes are enabled for the cluster.
- dedicated_
master_ strtype 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 Number of warm nodes in the cluster.
- warm_
type str Instance type for the OpenSearch cluster's warm nodes.
- zone_
awareness_ Sequence[Getconfigs Domain Cluster Config Zone Awareness Config] Configuration block containing zone awareness settings.
- zone_
awareness_ boolenabled Indicates whether zone awareness is enabled.
- warm_
enabled bool Warm storage is enabled.
- cold
Storage List<Property Map>Options Configuration block containing cold storage configuration.
- dedicated
Master NumberCount Number of dedicated master nodes in the cluster.
- dedicated
Master BooleanEnabled Indicates whether dedicated master nodes are enabled for the cluster.
- dedicated
Master StringType Instance type of the dedicated master nodes in the cluster.
- instance
Count Number Number of instances in the cluster.
- instance
Type String Instance type of data nodes in the cluster.
- warm
Count Number Number of warm nodes in the cluster.
- warm
Type String Instance type for the OpenSearch cluster's warm nodes.
- zone
Awareness List<Property Map>Configs Configuration block containing zone awareness settings.
- zone
Awareness BooleanEnabled Indicates whether zone awareness is enabled.
- warm
Enabled Boolean Warm storage 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
- Availability
Zone intCount Number of availability zones used.
- Availability
Zone intCount Number of availability zones used.
- availability
Zone IntegerCount Number of availability zones used.
- availability
Zone numberCount Number of availability zones used.
- availability_
zone_ intcount Number of availability zones used.
- availability
Zone NumberCount Number of availability zones used.
GetDomainCognitoOption
- Enabled bool
Whether node to node encryption is enabled.
- Identity
Pool stringId Cognito Identity pool used by the domain.
- Role
Arn string IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- User
Pool stringId Cognito User pool used by the domain.
- Enabled bool
Whether node to node encryption is enabled.
- Identity
Pool stringId Cognito Identity pool used by the domain.
- Role
Arn string IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- User
Pool stringId Cognito User pool used by the domain.
- enabled Boolean
Whether node to node encryption is enabled.
- identity
Pool StringId Cognito Identity pool used by the domain.
- role
Arn String IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- user
Pool StringId Cognito User pool used by the domain.
- enabled boolean
Whether node to node encryption is enabled.
- identity
Pool stringId Cognito Identity pool used by the domain.
- role
Arn string IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- user
Pool stringId Cognito User pool used by the domain.
- enabled bool
Whether node to node encryption is enabled.
- identity_
pool_ strid Cognito Identity pool used by the domain.
- role_
arn str IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- user_
pool_ strid Cognito User pool used by the domain.
- enabled Boolean
Whether node to node encryption is enabled.
- identity
Pool StringId Cognito Identity pool used by the domain.
- role
Arn String IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached.
- user
Pool StringId Cognito User pool used by the domain.
GetDomainEbsOption
- 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 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 string Type of EBS volumes attached to data nodes.
- ebs
Enabled 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.
- volume
Size Integer Size of EBS volumes attached to data nodes (in GB).
- volume
Type String Type of EBS volumes attached to data nodes.
- ebs
Enabled 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.
- volume
Size number Size of EBS volumes attached to data nodes (in GB).
- volume
Type 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.
- ebs
Enabled 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.
- volume
Size Number Size of EBS volumes attached to data nodes (in GB).
- volume
Type String Type of EBS volumes attached to data nodes.
GetDomainEncryptionAtRest
- enabled bool
Whether node to node encryption is enabled.
- kms_
key_ strid KMS key id used to encrypt data at rest.
GetDomainLogPublishingOption
- Cloudwatch
Log stringGroup Arn CloudWatch Log Group where the logs are published.
- Enabled bool
Whether node to node encryption is enabled.
- Log
Type string Type of OpenSearch log being published.
- Cloudwatch
Log stringGroup Arn CloudWatch Log Group where the logs are published.
- Enabled bool
Whether node to node encryption is enabled.
- Log
Type string Type of OpenSearch log being published.
- cloudwatch
Log StringGroup Arn CloudWatch Log Group where the logs are published.
- enabled Boolean
Whether node to node encryption is enabled.
- log
Type String Type of OpenSearch log being published.
- cloudwatch
Log stringGroup Arn CloudWatch Log Group where the logs are published.
- enabled boolean
Whether node to node encryption is enabled.
- log
Type string Type of OpenSearch log being published.
- cloudwatch_
log_ strgroup_ arn CloudWatch Log Group where the logs are published.
- enabled bool
Whether node to node encryption is enabled.
- log_
type str Type of OpenSearch log being published.
- cloudwatch
Log StringGroup Arn CloudWatch Log Group where the logs are published.
- enabled Boolean
Whether node to node encryption is enabled.
- log
Type String Type of OpenSearch 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
- Automated
Snapshot intStart Hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
- Automated
Snapshot intStart Hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
- automated
Snapshot IntegerStart Hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
- automated
Snapshot numberStart Hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
- automated_
snapshot_ intstart_ hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
- automated
Snapshot NumberStart Hour Hour during which the service takes an automated daily snapshot of the indices in the domain.
GetDomainVpcOption
- Availability
Zones List<string> Availability zones used by the domain.
- Security
Group List<string>Ids Security groups used by the domain.
- Subnet
Ids List<string> Subnets used by the domain.
- Vpc
Id string VPC used by the domain.
- Availability
Zones []string Availability zones used by the domain.
- Security
Group []stringIds Security groups used by the domain.
- Subnet
Ids []string Subnets used by the domain.
- Vpc
Id string VPC used by the domain.
- availability
Zones List<String> Availability zones used by the domain.
- security
Group List<String>Ids Security groups used by the domain.
- subnet
Ids List<String> Subnets used by the domain.
- vpc
Id String VPC used by the domain.
- availability
Zones string[] Availability zones used by the domain.
- security
Group string[]Ids Security groups used by the domain.
- subnet
Ids string[] Subnets used by the domain.
- vpc
Id string VPC used by the domain.
- availability_
zones Sequence[str] Availability zones used by the domain.
- security_
group_ Sequence[str]ids Security groups used by the domain.
- subnet_
ids Sequence[str] Subnets used by the domain.
- vpc_
id str VPC used by the domain.
- availability
Zones List<String> Availability zones used by the domain.
- security
Group List<String>Ids Security groups used by the domain.
- subnet
Ids List<String> Subnets used by the domain.
- vpc
Id String 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.
Try AWS Native preview for resources not in the classic version.