AWS Native v0.126.0, Sep 30 24

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.opensearchservice.getDomain

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

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,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[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-native:opensearchservice:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string

A name for the OpenSearch Service domain. The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

DomainName string

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

domainName String

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

domainName string

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

domain_name str

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

domainName String

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

getDomain Result

The following output properties are available:

AccessPolicies object

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

AdvancedOptions Dictionary<string, string>

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

AdvancedSecurityOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainAdvancedSecurityOptionsInput

Specifies options for fine-grained access control and SAML authentication.

If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.

Arn string

The Amazon Resource Name (ARN) of the CloudFormation stack.

ClusterConfig Pulumi.AwsNative.OpenSearchService.Outputs.DomainClusterConfig

Container for the cluster configuration of a domain.

CognitoOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainCognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

DomainArn string

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

DomainEndpoint string

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

DomainEndpointOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEndpointOptions

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

DomainEndpointV2 string

If IPAddressType to set to dualstack , a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

DomainEndpoints Dictionary<string, string>

EbsOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEbsOptions

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

EncryptionAtRestOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

EngineVersion string

The version of OpenSearch to use. The value must be in the format OpenSearch_X.Y or Elasticsearch_X.Y . If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .

If you set the EnableVersionUpgrade update policy to true , you can update EngineVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating EngineVersion results in replacement .

Id string

The resource ID. For example, 123456789012/my-domain .

IpAddressType string

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

LogPublishingOptions Dictionary<string, Pulumi.AwsNative.OpenSearchService.Outputs.DomainLogPublishingOption>

An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish. Each key needs a valid LogPublishingOption value. For the full syntax, see the examples .

NodeToNodeEncryptionOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainNodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

OffPeakWindowOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainOffPeakWindowOptions

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

ServiceSoftwareOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainServiceSoftwareOptions

SkipShardMigrationWait bool

SnapshotOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainSnapshotOptions

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

SoftwareUpdateOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainSoftwareUpdateOptions

Service software update options for the domain.

Tags List<Pulumi.AwsNative.Outputs.Tag>

An arbitrary set of tags (key-value pairs) for this Domain.

VpcOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainVpcOptions

The virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .

If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.

AccessPolicies interface{}

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

AdvancedOptions map[string]string

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

AdvancedSecurityOptions DomainAdvancedSecurityOptionsInput

Specifies options for fine-grained access control and SAML authentication.

Arn string

The Amazon Resource Name (ARN) of the CloudFormation stack.

ClusterConfig DomainClusterConfig

Container for the cluster configuration of a domain.

CognitoOptions DomainCognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

DomainArn string

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

DomainEndpoint string

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

DomainEndpointOptions DomainEndpointOptions

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

DomainEndpointV2 string

DomainEndpoints map[string]string

EbsOptions DomainEbsOptions

EncryptionAtRestOptions DomainEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

EngineVersion string

Id string

The resource ID. For example, 123456789012/my-domain .

IpAddressType string

LogPublishingOptions map[string]DomainLogPublishingOption

NodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

OffPeakWindowOptions DomainOffPeakWindowOptions

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

ServiceSoftwareOptions DomainServiceSoftwareOptions

SkipShardMigrationWait bool

SnapshotOptions DomainSnapshotOptions

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

SoftwareUpdateOptions DomainSoftwareUpdateOptions

Service software update options for the domain.

Tags Tag

An arbitrary set of tags (key-value pairs) for this Domain.

VpcOptions DomainVpcOptions

accessPolicies Object

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

advancedOptions Map<String,String>

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

advancedSecurityOptions DomainAdvancedSecurityOptionsInput

Specifies options for fine-grained access control and SAML authentication.

arn String

The Amazon Resource Name (ARN) of the CloudFormation stack.

clusterConfig DomainClusterConfig

Container for the cluster configuration of a domain.

cognitoOptions DomainCognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

domainArn String

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domainEndpoint String

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

domainEndpointOptions DomainEndpointOptions

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

domainEndpointV2 String

domainEndpoints Map<String,String>

ebsOptions DomainEbsOptions

encryptionAtRestOptions DomainEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

engineVersion String

id String

The resource ID. For example, 123456789012/my-domain .

ipAddressType String

logPublishingOptions Map<String,DomainLogPublishingOption>

nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

offPeakWindowOptions DomainOffPeakWindowOptions

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

serviceSoftwareOptions DomainServiceSoftwareOptions

skipShardMigrationWait Boolean

snapshotOptions DomainSnapshotOptions

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

softwareUpdateOptions DomainSoftwareUpdateOptions

Service software update options for the domain.

tags List<Tag>

An arbitrary set of tags (key-value pairs) for this Domain.

vpcOptions DomainVpcOptions

accessPolicies any

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

advancedOptions {[key: string]: string}

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

advancedSecurityOptions DomainAdvancedSecurityOptionsInput

Specifies options for fine-grained access control and SAML authentication.

arn string

The Amazon Resource Name (ARN) of the CloudFormation stack.

clusterConfig DomainClusterConfig

Container for the cluster configuration of a domain.

cognitoOptions DomainCognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

domainArn string

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domainEndpoint string

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

domainEndpointOptions DomainEndpointOptions

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

domainEndpointV2 string

domainEndpoints {[key: string]: string}

ebsOptions DomainEbsOptions

encryptionAtRestOptions DomainEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

engineVersion string

id string

The resource ID. For example, 123456789012/my-domain .

ipAddressType string

logPublishingOptions {[key: string]: DomainLogPublishingOption}

nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

offPeakWindowOptions DomainOffPeakWindowOptions

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

serviceSoftwareOptions DomainServiceSoftwareOptions

skipShardMigrationWait boolean

snapshotOptions DomainSnapshotOptions

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

softwareUpdateOptions DomainSoftwareUpdateOptions

Service software update options for the domain.

tags Tag[]

An arbitrary set of tags (key-value pairs) for this Domain.

vpcOptions DomainVpcOptions

access_policies Any

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

advanced_options Mapping[str, str]

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

advanced_security_options DomainAdvancedSecurityOptionsInput

Specifies options for fine-grained access control and SAML authentication.

arn str

The Amazon Resource Name (ARN) of the CloudFormation stack.

cluster_config DomainClusterConfig

Container for the cluster configuration of a domain.

cognito_options DomainCognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

domain_arn str

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domain_endpoint str

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

domain_endpoint_options DomainEndpointOptions

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

domain_endpoint_v2 str

domain_endpoints Mapping[str, str]

ebs_options DomainEbsOptions

encryption_at_rest_options DomainEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

engine_version str

id str

The resource ID. For example, 123456789012/my-domain .

ip_address_type str

log_publishing_options Mapping[str, DomainLogPublishingOption]

node_to_node_encryption_options DomainNodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

off_peak_window_options DomainOffPeakWindowOptions

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

service_software_options DomainServiceSoftwareOptions

skip_shard_migration_wait bool

snapshot_options DomainSnapshotOptions

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

software_update_options DomainSoftwareUpdateOptions

Service software update options for the domain.

tags Sequence[root_Tag]

An arbitrary set of tags (key-value pairs) for this Domain.

vpc_options DomainVpcOptions

accessPolicies Any

Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.

advancedOptions Map<String>

Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.

advancedSecurityOptions Property Map

Specifies options for fine-grained access control and SAML authentication.

arn String

The Amazon Resource Name (ARN) of the CloudFormation stack.

clusterConfig Property Map

Container for the cluster configuration of a domain.

cognitoOptions Property Map

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

domainArn String

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domainEndpoint String

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

domainEndpointOptions Property Map

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

domainEndpointV2 String

domainEndpoints Map<String>

ebsOptions Property Map

encryptionAtRestOptions Property Map

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service .

engineVersion String

id String

The resource ID. For example, 123456789012/my-domain .

ipAddressType String

logPublishingOptions Map<Property Map>

nodeToNodeEncryptionOptions Property Map

Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .

offPeakWindowOptions Property Map

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

serviceSoftwareOptions Property Map

skipShardMigrationWait Boolean

snapshotOptions Property Map

DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.

softwareUpdateOptions Property Map

Service software update options for the domain.

tags List<Property Map>

An arbitrary set of tags (key-value pairs) for this Domain.

vpcOptions Property Map

Supporting Types

DomainAdvancedSecurityOptionsInput

AnonymousAuthDisableDate string: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
AnonymousAuthEnabled bool: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
Enabled bool: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
InternalUserDatabaseEnabled bool: True to enable the internal user database.
JwtOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainJwtOptions: Container for information about the JWT configuration of the Amazon OpenSearch Service.
MasterUserOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainMasterUserOptions: Specifies information about the master user.
SamlOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainSamlOptions: Container for information about the SAML configuration for OpenSearch Dashboards.

AnonymousAuthDisableDate string: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
AnonymousAuthEnabled bool: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
Enabled bool: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
InternalUserDatabaseEnabled bool: True to enable the internal user database.
JwtOptions DomainJwtOptions: Container for information about the JWT configuration of the Amazon OpenSearch Service.
MasterUserOptions DomainMasterUserOptions: Specifies information about the master user.
SamlOptions DomainSamlOptions: Container for information about the SAML configuration for OpenSearch Dashboards.

anonymousAuthDisableDate String: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
anonymousAuthEnabled Boolean: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
enabled Boolean: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
internalUserDatabaseEnabled Boolean: True to enable the internal user database.
jwtOptions DomainJwtOptions: Container for information about the JWT configuration of the Amazon OpenSearch Service.
masterUserOptions DomainMasterUserOptions: Specifies information about the master user.
samlOptions DomainSamlOptions: Container for information about the SAML configuration for OpenSearch Dashboards.

anonymousAuthDisableDate string: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
anonymousAuthEnabled boolean: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
enabled boolean: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
internalUserDatabaseEnabled boolean: True to enable the internal user database.
jwtOptions DomainJwtOptions: Container for information about the JWT configuration of the Amazon OpenSearch Service.
masterUserOptions DomainMasterUserOptions: Specifies information about the master user.
samlOptions DomainSamlOptions: Container for information about the SAML configuration for OpenSearch Dashboards.

anonymous_auth_disable_date str: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
anonymous_auth_enabled bool: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
enabled bool: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
internal_user_database_enabled bool: True to enable the internal user database.
jwt_options DomainJwtOptions: Container for information about the JWT configuration of the Amazon OpenSearch Service.
master_user_options DomainMasterUserOptions: Specifies information about the master user.
saml_options DomainSamlOptions: Container for information about the SAML configuration for OpenSearch Dashboards.

anonymousAuthDisableDate String: Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
anonymousAuthEnabled Boolean: True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
enabled Boolean: True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
internalUserDatabaseEnabled Boolean: True to enable the internal user database.
jwtOptions Property Map: Container for information about the JWT configuration of the Amazon OpenSearch Service.
masterUserOptions Property Map: Specifies information about the master user.
samlOptions Property Map: Container for information about the SAML configuration for OpenSearch Dashboards.

DomainClusterConfig

ColdStorageOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainColdStorageOptions: Container for cold storage configuration options.
DedicatedMasterCount int: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
DedicatedMasterEnabled bool: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
DedicatedMasterType string: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
InstanceCount int: The number of data nodes (instances) to use in the OpenSearch Service domain.
InstanceType string: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
MultiAzWithStandbyEnabled bool: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
WarmCount int: The number of warm nodes in the cluster.
WarmEnabled bool: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
WarmType string: The instance type for the cluster's warm nodes.
ZoneAwarenessConfig Pulumi.AwsNative.OpenSearchService.Inputs.DomainZoneAwarenessConfig: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
ZoneAwarenessEnabled bool: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

ColdStorageOptions DomainColdStorageOptions: Container for cold storage configuration options.
DedicatedMasterCount int: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
DedicatedMasterEnabled bool: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
DedicatedMasterType string: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
InstanceCount int: The number of data nodes (instances) to use in the OpenSearch Service domain.
InstanceType string: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
MultiAzWithStandbyEnabled bool: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
WarmCount int: The number of warm nodes in the cluster.
WarmEnabled bool: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
WarmType string: The instance type for the cluster's warm nodes.
ZoneAwarenessConfig DomainZoneAwarenessConfig: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
ZoneAwarenessEnabled bool: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

coldStorageOptions DomainColdStorageOptions: Container for cold storage configuration options.
dedicatedMasterCount Integer: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
dedicatedMasterEnabled Boolean: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
dedicatedMasterType String: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instanceCount Integer: The number of data nodes (instances) to use in the OpenSearch Service domain.
instanceType String: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multiAzWithStandbyEnabled Boolean: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
warmCount Integer: The number of warm nodes in the cluster.
warmEnabled Boolean: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
warmType String: The instance type for the cluster's warm nodes.
zoneAwarenessConfig DomainZoneAwarenessConfig: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
zoneAwarenessEnabled Boolean: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

coldStorageOptions DomainColdStorageOptions: Container for cold storage configuration options.
dedicatedMasterCount number: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
dedicatedMasterEnabled boolean: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
dedicatedMasterType string: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instanceCount number: The number of data nodes (instances) to use in the OpenSearch Service domain.
instanceType string: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multiAzWithStandbyEnabled boolean: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
warmCount number: The number of warm nodes in the cluster.
warmEnabled boolean: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
warmType string: The instance type for the cluster's warm nodes.
zoneAwarenessConfig DomainZoneAwarenessConfig: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
zoneAwarenessEnabled boolean: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

cold_storage_options DomainColdStorageOptions: Container for cold storage configuration options.
dedicated_master_count int: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
dedicated_master_enabled bool: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
dedicated_master_type str: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instance_count int: The number of data nodes (instances) to use in the OpenSearch Service domain.
instance_type str: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multi_az_with_standby_enabled bool: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
warm_count int: The number of warm nodes in the cluster.
warm_enabled bool: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
warm_type str: The instance type for the cluster's warm nodes.
zone_awareness_config DomainZoneAwarenessConfig: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
zone_awareness_enabled bool: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

coldStorageOptions Property Map: Container for cold storage configuration options.
dedicatedMasterCount Number: The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
dedicatedMasterEnabled Boolean: Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
dedicatedMasterType String: The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instanceCount Number: The number of data nodes (instances) to use in the OpenSearch Service domain.
instanceType String: The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multiAzWithStandbyEnabled Boolean: Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
warmCount Number: The number of warm nodes in the cluster.
warmEnabled Boolean: Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
warmType String: The instance type for the cluster's warm nodes.
zoneAwarenessConfig Property Map: Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
zoneAwarenessEnabled Boolean: Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

DomainCognitoOptions

Enabled bool

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See Amazon Cognito authentication for OpenSearch Dashboards .

IdentityPoolId string

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.