capabilities.work

Ensure Domain Exists

A 4-step recipe with Amazon OpenSearch Service. We can help you get access.

Recipe · 4 steps

Ensure Domain Exists

Create the domain only if it does not already exist.

  1. List all domain names in the account to determine whether the requested domain already exists.
  2. Describe the requested domain to capture its current configuration. This step runs when the domain is expected to already exist; if it does not the flow falls through to create it.
  3. Create the domain because it was not found in the account, using the supplied engine version, cluster configuration, and EBS options.
  4. Describe the newly created domain until it reports a published endpoint, looping while the endpoint remains empty.
What you'll need to have ready
  • domainName: Name of the OpenSearch domain to ensure exists.
  • engineVersion: OpenSearch or Elasticsearch engine version to create with.
  • clusterConfig: Container for the cluster configuration.
  • ebsOptions: Container for EBS-based storage options.
For your developer

Arazzo workflow amazon-opensearch-service:ensure-domain-exists, 4 operations: ListDomainNames → DescribeDomain → CreateDomain → DescribeDomain. Specs on APIs.io.