/2015-01-01/es/domain - Amazon Elasticsearch Service

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/domain' \ --header 'Content-Type: application/json' \ --data-raw '{ "DomainName": "string", "ElasticsearchVersion": "string", "ElasticsearchClusterConfig": { "InstanceType": "m3.medium.elasticsearch", "InstanceCount": 0, "DedicatedMasterEnabled": true, "ZoneAwarenessEnabled": true, "ZoneAwarenessConfig": { "AvailabilityZoneCount": 0 }, "DedicatedMasterType": "m3.medium.elasticsearch", "DedicatedMasterCount": 0, "WarmEnabled": true, "WarmType": "ultrawarm1.medium.elasticsearch", "WarmCount": 0, "ColdStorageOptions": { "Enabled": true } }, "EBSOptions": { "EBSEnabled": true, "VolumeType": "standard", "VolumeSize": 0, "Iops": 0, "Throughput": 0 }, "AccessPolicies": "string", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "VPCOptions": { "SubnetIds": [], "SecurityGroupIds": [] }, "CognitoOptions": { "Enabled": true, "UserPoolId": "string", "IdentityPoolId": "string", "RoleArn": "string" }, "EncryptionAtRestOptions": { "Enabled": true, "KmsKeyId": "string" }, "NodeToNodeEncryptionOptions": { "Enabled": true }, "AdvancedOptions": { "property1": "string", "property2": "string" }, "LogPublishingOptions": { "property1": { "CloudWatchLogsLogGroupArn": "string", "Enabled": true } }, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": true, "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string" }, "AdvancedSecurityOptions": { "Enabled": true, "InternalUserDatabaseEnabled": true, "MasterUserOptions": { "MasterUserARN": "string", "MasterUserName": "string", "MasterUserPassword": "string" }, "SAMLOptions": { "Enabled": true, "Idp": { "MetadataContent": "string", "EntityId": "string" }, "MasterUserName": "string", "MasterBackendRole": "string", "SubjectKey": "string", "RolesKey": "string", "SessionTimeoutMinutes": 0 }, "AnonymousAuthEnabled": true }, "AutoTuneOptions": { "DesiredState": "ENABLED", "MaintenanceSchedules": [] }, "TagList": [ { "Key": "string", "Value": "string" } ] }'

{ "DomainStatus": { "DomainId": "string", "DomainName": "string", "ARN": "string", "Created": true, "Deleted": true, "Endpoint": "string", "Endpoints": { "property1": "string", "property2": "string" }, "Processing": true, "UpgradeProcessing": true, "ElasticsearchVersion": "string", "ElasticsearchClusterConfig": { "InstanceType": "m3.medium.elasticsearch", "InstanceCount": 0, "DedicatedMasterEnabled": true, "ZoneAwarenessEnabled": true, "ZoneAwarenessConfig": { "AvailabilityZoneCount": 0 }, "DedicatedMasterType": "m3.medium.elasticsearch", "DedicatedMasterCount": 0, "WarmEnabled": true, "WarmType": "ultrawarm1.medium.elasticsearch", "WarmCount": 0, "ColdStorageOptions": { "Enabled": true } }, "EBSOptions": { "EBSEnabled": true, "VolumeType": "standard", "VolumeSize": 0, "Iops": 0, "Throughput": 0 }, "AccessPolicies": "string", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "VPCOptions": { "VPCId": "string", "SubnetIds": [], "AvailabilityZones": [], "SecurityGroupIds": [] }, "CognitoOptions": { "Enabled": true, "UserPoolId": "string", "IdentityPoolId": "string", "RoleArn": "string" }, "EncryptionAtRestOptions": { "Enabled": true, "KmsKeyId": "string" }, "NodeToNodeEncryptionOptions": { "Enabled": true }, "AdvancedOptions": {}, "LogPublishingOptions": { "property1": { "CloudWatchLogsLogGroupArn": "string", "Enabled": true } }, "ServiceSoftwareOptions": { "CurrentVersion": "string", "NewVersion": "string", "UpdateAvailable": true, "Cancellable": true, "UpdateStatus": "PENDING_UPDATE", "Description": "string", "AutomatedUpdateDate": "string", "OptionalDeployment": true }, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": true, "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string" }, "AdvancedSecurityOptions": { "Enabled": true, "InternalUserDatabaseEnabled": true, "SAMLOptions": { "Enabled": true, "Idp": { "MetadataContent": "string", "EntityId": "string" }, "SubjectKey": "string", "RolesKey": "string", "SessionTimeoutMinutes": 0 }, "AnonymousAuthDisableDate": "string", "AnonymousAuthEnabled": true }, "AutoTuneOptions": { "State": "ENABLED", "ErrorMessage": "string" }, "ChangeProgressDetails": { "ChangeId": "string", "Message": "string" } } }

Request

Body Params application/json

DomainName

string

required

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

>= 3 characters<= 28 characters

Match pattern:

[a-z][a-z0-9\-]+

ElasticsearchVersion

string

optional

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Match pattern:

^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

ElasticsearchClusterConfig

object

optional

Specifies the configuration for the domain cluster, such as the type and number of instances.

InstanceType

enum<string>

optional

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

Allowed values:

m3.medium.elasticsearchm3.large.elasticsearchm3.xlarge.elasticsearchm3.2xlarge.elasticsearchm4.large.elasticsearchm4.xlarge.elasticsearchm4.2xlarge.elasticsearchm4.4xlarge.elasticsearchm4.10xlarge.elasticsearchm5.large.elasticsearchm5.xlarge.elasticsearchm5.2xlarge.elasticsearchm5.4xlarge.elasticsearchm5.12xlarge.elasticsearchr5.large.elasticsearchr5.xlarge.elasticsearchr5.2xlarge.elasticsearchr5.4xlarge.elasticsearchr5.12xlarge.elasticsearchc5.large.elasticsearchc5.xlarge.elasticsearchc5.2xlarge.elasticsearchc5.4xlarge.elasticsearchc5.9xlarge.elasticsearchc5.18xlarge.elasticsearchultrawarm1.medium.elasticsearchultrawarm1.large.elasticsearcht2.micro.elasticsearcht2.small.elasticsearcht2.medium.elasticsearchr3.large.elasticsearchr3.xlarge.elasticsearchr3.2xlarge.elasticsearchr3.4xlarge.elasticsearchr3.8xlarge.elasticsearchi2.xlarge.elasticsearchi2.2xlarge.elasticsearchd2.xlarge.elasticsearchd2.2xlarge.elasticsearchd2.4xlarge.elasticsearchd2.8xlarge.elasticsearchc4.large.elasticsearchc4.xlarge.elasticsearchc4.2xlarge.elasticsearchc4.4xlarge.elasticsearchc4.8xlarge.elasticsearchr4.large.elasticsearchr4.xlarge.elasticsearchr4.2xlarge.elasticsearchr4.4xlarge.elasticsearchr4.8xlarge.elasticsearchr4.16xlarge.elasticsearchi3.large.elasticsearchi3.xlarge.elasticsearchi3.2xlarge.elasticsearchi3.4xlarge.elasticsearchi3.8xlarge.elasticsearchi3.16xlarge.elasticsearch

InstanceCount

integer

optional

The number of instances in the specified domain cluster.

DedicatedMasterEnabled

boolean

optional

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

ZoneAwarenessEnabled

boolean

optional

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

ZoneAwarenessConfig

object

optional

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

DedicatedMasterType

enum<string>

optional

The instance type for a dedicated master node.

Allowed values:

DedicatedMasterCount

integer

optional

Total number of dedicated master nodes, active and on standby, for the cluster.

WarmEnabled

boolean

optional

True to enable warm storage.

WarmType

enum<string>

optional

The instance type for the Elasticsearch cluster's warm nodes.

Allowed values:

ultrawarm1.medium.elasticsearchultrawarm1.large.elasticsearch

WarmCount

integer

optional

The number of warm nodes in the cluster.

ColdStorageOptions

object

optional

Specifies the ColdStorageOptions config for Elasticsearch Domain

EBSOptions

object

optional

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

EBSEnabled

boolean

optional

Specifies whether EBS-based storage is enabled.

VolumeType

enum<string>

optional

Specifies the volume type for EBS-based storage.

Allowed values:

standardgp2io1gp3

VolumeSize

integer

optional

Integer to specify the size of an EBS volume.

Iops

integer

optional

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

Throughput

integer

optional

Specifies the Throughput for GP3 EBS volume (SSD).

AccessPolicies

string

optional

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

SnapshotOptions

object

optional

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

AutomatedSnapshotStartHour

integer

optional

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

VPCOptions

object

optional

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

SubnetIds

array[string]

optional

Specifies the subnets for VPC endpoint.

SecurityGroupIds

array[string]

optional

Specifies the security groups for VPC endpoint.

CognitoOptions

object

optional

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

Enabled

boolean

optional

Specifies the option to enable Cognito for Kibana authentication.

UserPoolId

string

optional

Specifies the Cognito user pool ID for Kibana authentication.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

IdentityPoolId

string

optional

Specifies the Cognito identity pool ID for Kibana authentication.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+:[0-9a-f-]+

RoleArn

string

optional

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

>= 20 characters<= 2048 characters

EncryptionAtRestOptions

object

optional

Specifies the Encryption At Rest Options.

Enabled

boolean

optional

Specifies the option to enable Encryption At Rest.

KmsKeyId

string

optional

Specifies the KMS Key ID for Encryption At Rest options.

>= 1 characters<= 500 characters

NodeToNodeEncryptionOptions

object

optional

Specifies the node-to-node encryption options.

Enabled

boolean

optional

Specify true to enable node-to-node encryption.

AdvancedOptions

object

optional

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

Additional properties

string

optional

LogPublishingOptions

object

optional

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

Additional properties

object (LogPublishingOption)

optional

Log Publishing option that is set for given domain.
Attributes and their details:

CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
Enabled: Whether the log publishing for given log type is enabled or not

DomainEndpointOptions

object

optional

Options to configure endpoint for the Elasticsearch domain.

EnforceHTTPS

boolean

optional

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

TLSSecurityPolicy

enum<string>

optional

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

Allowed values:

Policy-Min-TLS-1-0-2019-07Policy-Min-TLS-1-2-2019-07

CustomEndpointEnabled

boolean

optional

Specify if custom endpoint should be enabled for the Elasticsearch domain.

CustomEndpoint

string

optional

Specify the fully qualified domain for your custom endpoint.

>= 1 characters<= 255 characters

Match pattern:

^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$

CustomEndpointCertificateArn

string

optional

Specify ACM certificate ARN for your custom endpoint.

AdvancedSecurityOptions

object

optional

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

Enabled

boolean

optional

True if advanced security is enabled.

InternalUserDatabaseEnabled

boolean

optional

True if the internal user database is enabled.

MasterUserOptions

object

optional

Credentials for the master user: username and password, ARN, or both.

SAMLOptions

object

optional

Specifies the SAML application configuration for the domain.

AnonymousAuthEnabled

boolean

optional

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

AutoTuneOptions

object

optional

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

DesiredState

enum<string>

optional

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

Allowed values:

ENABLEDDISABLED

MaintenanceSchedules

array[object (AutoTuneMaintenanceSchedule) {3}]

optional

Specifies list of maitenance schedules. See the Developer Guide for more information.

<= 100 items

TagList

array[object (Tag) {2}]

optional

A list of Tag

Key

string

required

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

>= 1 characters<= 128 characters

Value

string

required

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

>= 0 characters<= 256 characters

Examples

Responses

🟢200Success

application/json

Body

The result of a <code>CreateElasticsearchDomain</code> operation. Contains the status of the newly created Elasticsearch domain.

DomainStatus

object

optional

The status of the newly created Elasticsearch domain.

DomainId

string

required

The unique identifier for the specified Elasticsearch domain.

>= 1 characters<= 64 characters

DomainName

string

required

>= 3 characters<= 28 characters

Match pattern:

[a-z][a-z0-9\-]+

ARN

string

required

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Created

boolean

optional

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

Deleted

boolean

optional

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Endpoint

string

optional

The Elasticsearch domain endpoint that you use to submit index and search requests.

Endpoints

object

optional

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

Processing

boolean

optional

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

UpgradeProcessing

boolean

optional

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

ElasticsearchVersion

string

ElasticsearchVersionString

optional

Match pattern:

^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

ElasticsearchClusterConfig

object

required

The type and number of instances in the domain cluster.

EBSOptions

object

optional

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

AccessPolicies

string

optional

IAM access policy as a JSON-formatted string.

SnapshotOptions

object

optional

Specifies the status of the SnapshotOptions

VPCOptions

object

optional

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

CognitoOptions

object

optional

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

EncryptionAtRestOptions

object

optional

Specifies the status of the EncryptionAtRestOptions.

NodeToNodeEncryptionOptions

object

optional

Specifies the status of the NodeToNodeEncryptionOptions.

AdvancedOptions

object

optional

Specifies the status of the AdvancedOptions

LogPublishingOptions

object

optional

Log publishing options for the given domain.

ServiceSoftwareOptions

object

optional

The current status of the Elasticsearch domain's service software.

DomainEndpointOptions

object

optional

The current status of the Elasticsearch domain's endpoint options.

AdvancedSecurityOptions

object

optional

The current status of the Elasticsearch domain's advanced security options.

AutoTuneOptions

object

optional

The current status of the Elasticsearch domain's Auto-Tune options.

ChangeProgressDetails

object

optional

Specifies change details of the domain configuration change.

🟠480BaseException

🟠481DisabledOperationException

🟠482InternalException

🟠483InvalidTypeException

🟠484LimitExceededException

🟠485ResourceAlreadyExistsException

🟠486ValidationException