aws::opensearch-domain¶
Creates an opensearch domain.
Example¶
aws::opensearch-domain opensearch-domain-example
domain-name: "testdomain3"
open-search-version: "OpenSearch_1.0"
ebs-options
enable-ebs: true
volume-type: standard
volume-count: 10
end
node-to-node-encryption-options
enable-node-to-node-encryption: true
end
encryption-at-rest-options
enable-encryption-at-rest: true
end
cluster-configuration
enable-zone-awareness: true
instance-count: 4
zone-awareness-configuration
availability-zone-count: 2
end
end
domain-endpoint-options
enforce-https: true
end
advanced-security-options
enable-advanced-security-options: true
enable-internal-user-database: true
master-user-options
master-username: "masteruser"
master-password: "MasterUser1!"
end
end
access-policies: "access-policy.json"
advanced-options: {
"indices.query.bool.max_clause_count": "1026"
}
tags: {
"description": "Test Domain"
}
vpc-options
subnets: [
$(aws::subnet example-subnet-1),
$(aws::subnet example-subnet-3)
]
security-groups: [
$(aws::security-group example-security-group)
]
end
end
Attributes¶
| Attribute | Description |
|---|---|
| open-search-version | The version of OpenSearch. Valid values satisfy one of the following regexes: Must be Should be in the format of ‘Elasticsearch_X.Y’. Valid values satisfy the regex: |
| domain-name | The name of the OpenSearch Domain. The name can be a combination of lowercase letters, numbers, or hyphens (-) and it must start with a lowercase letter. It can be between 3 to 28 characters in length. Valid values satisfy the regex: [^[a-z]([a-z]|[0-9]|-){2,27}$]. (Required) |
| ebs-options subresource | The Elastic Block Storage options configuration.
|
| cluster-configuration subresource | The OpenSearch Domain cluster configuration.
|
| snapshot-options subresource | The automated snapshot time configuration.
|
| access-policies | The Json formatted IAM access policies. It can either be a JSON formatted string or the file path to a .json file. |
| advanced-options map | Configure advanced options for the cluster to allow references to indices in an HTTP request body. The valid options are
|
| node-to-node-encryption-options subresource | The node to node encryption options configuration.
|
| domain-endpoint-options subresource | The OpenSearch domain endpoint options configuration.
|
| encryption-at-rest-options subresource | The encryption at rest options configuration.
|
| vpc-options subresource | The VPC options configuration.
|
| advanced-security-options subresource | The advanced security options configuration.
|
| off-peak-window-options subresource | The off-peak window options configuration.
|
| ip-address-type | The IP address type for the OpenSearch domain. Valid values are ipv4 or dualstack. |
| auto-tune-options subresource | The auto-tune options configuration.
|
| tags map | The list of tags. |
Outputs¶
| Attribute | Description |
|---|---|
| id | The ID of the OpenSearch domain. |
| arn | The Amazon Resource Name of an OpenSearch domain. |
| endpoints map | The endpoints of the OpenSearch domain. |
| endpoint | The Domain-specific endpoint used to submit index, search, and data upload requests to the domain. |
| endpoint-v2 | The V2 endpoint of the OpenSearch domain. 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.
This is provided if the domain is created with the |