opensearchservice_create_domain: Creates an Amazon OpenSearch Service domain

Description

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

See https://www.paws-r-sdk.com/docs/opensearchservice_create_domain/ for full documentation.

Usage

opensearchservice_create_domain(
  DomainName,
  EngineVersion = NULL,
  ClusterConfig = NULL,
  EBSOptions = NULL,
  AccessPolicies = NULL,
  IPAddressType = NULL,
  SnapshotOptions = NULL,
  VPCOptions = NULL,
  CognitoOptions = NULL,
  EncryptionAtRestOptions = NULL,
  NodeToNodeEncryptionOptions = NULL,
  AdvancedOptions = NULL,
  LogPublishingOptions = NULL,
  DomainEndpointOptions = NULL,
  AdvancedSecurityOptions = NULL,
  IdentityCenterOptions = NULL,
  TagList = NULL,
  AutoTuneOptions = NULL,
  OffPeakWindowOptions = NULL,
  SoftwareUpdateOptions = NULL,
  AIMLOptions = NULL
)

Arguments

DomainName

[required] Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

EngineVersion

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

ClusterConfig

Container for the cluster configuration of a domain.

EBSOptions

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

AccessPolicies

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

IPAddressType

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

SnapshotOptions

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

VPCOptions

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

CognitoOptions

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

EncryptionAtRestOptions

Key-value pairs to enable encryption at rest.

NodeToNodeEncryptionOptions

Enables node-to-node encryption.

AdvancedOptions

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

LogPublishingOptions

Key-value pairs to configure log publishing.

DomainEndpointOptions

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

AdvancedSecurityOptions

Options for fine-grained access control.

IdentityCenterOptions

Options for IAM Identity Center Option control for the domain.

TagList

List of tags to add to the domain upon creation.

AutoTuneOptions

Options for Auto-Tune.

OffPeakWindowOptions

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

SoftwareUpdateOptions

Software update options for the domain.

AIMLOptions

Options for all machine learning features for the specified domain.