/2015-01-01/es/domain

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

POST

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

Request Example

Shell

JavaScript

Java

Swift

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"
        }
    ]
}'

Response Example

200 - Example 1

{
    "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

Examples

Responses

🟢200Success

application/json

Body

🟠480BaseException

🟠481DisabledOperationException

🟠482InternalException

🟠483InvalidTypeException

🟠484LimitExceededException

🟠485ResourceAlreadyExistsException

🟠486ValidationException

Modified at 2023-08-15 04:15:53

/2015-01-01/es/serviceSoftwareUpdate/cancel

/2015-01-01/es/ccs/outboundConnection