interface DomainProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.OpenSearchService.DomainProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#DomainProps |
![]() | software.amazon.awscdk.services.opensearchservice.DomainProps |
![]() | aws_cdk.aws_opensearchservice.DomainProps |
![]() | aws-cdk-lib » aws_opensearchservice » DomainProps |
Properties for an Amazon OpenSearch Service domain.
Example
const domain = new Domain(this, 'Domain', {
version: EngineVersion.OPENSEARCH_1_0,
ebs: {
volumeSize: 100,
volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD,
},
nodeToNodeEncryption: true,
encryptionAtRest: {
enabled: true,
},
});
Properties
Name | Type | Description |
---|---|---|
version | Engine | The Elasticsearch/OpenSearch version that your domain will leverage. |
access | Policy [] | Domain access policies. |
advanced | { [string]: string } | Additional options to specify for the Amazon OpenSearch Service domain. |
automated | number | The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain. |
capacity? | Capacity | The cluster capacity configuration for the Amazon OpenSearch Service domain. |
cognito | Cognito | Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. |
cold | boolean | Whether to enable or disable cold storage on the domain. |
custom | Custom | To configure a custom domain configure these options. |
domain | string | Enforces a particular physical domain name. |
ebs? | Ebs | The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain. |
enable | boolean | Specifies whether automatic service software updates are enabled for the domain. |
enable | boolean | To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy. |
encryption | Encryption | Encryption at rest options for the cluster. |
enforce | boolean | True to require that all traffic to the domain arrive over HTTPS. |
fine | Advanced | Specifies options for fine-grained access control. |
ip | Ip | Specify either dual stack or IPv4 as your IP address type. |
logging? | Logging | Configuration log publishing configuration options. |
node | boolean | Specify true to enable node to node encryption. |
off | boolean | Options for enabling a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. |
off | Window | Start time for the off-peak window, in Coordinated Universal Time (UTC). |
removal | Removal | Policy to apply when the domain is removed from the stack. |
security | ISecurity [] | The list of security groups that are associated with the VPC endpoints for the domain. |
suppress | boolean | Specify whether to create a CloudWatch Logs resource policy or not. |
tls | TLSSecurity | The minimum TLS version required for traffic to the domain. |
use | boolean | Configures the domain so that unsigned basic auth is enabled. |
vpc? | IVpc | Place the domain inside this VPC. |
vpc | Subnet [] | The specific vpc subnets the domain will be placed in. |
zone | Zone | The cluster zone awareness configuration for the Amazon OpenSearch Service domain. |
version
Type:
Engine
The Elasticsearch/OpenSearch version that your domain will leverage.
accessPolicies?
Type:
Policy
[]
(optional, default: No access policies.)
Domain access policies.
advancedOptions?
Type:
{ [string]: string }
(optional, default: no advanced options are specified)
Additional options to specify for the Amazon OpenSearch Service domain.
automatedSnapshotStartHour?
Type:
number
(optional, default: Hourly automated snapshots not used)
The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain.
Only applies for Elasticsearch versions below 5.3.
capacity?
Type:
Capacity
(optional, default: 1 r5.large.search data node; no dedicated master nodes.)
The cluster capacity configuration for the Amazon OpenSearch Service domain.
cognitoDashboardsAuth?
Type:
Cognito
(optional, default: Cognito not used for authentication to OpenSearch Dashboards.)
Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
coldStorageEnabled?
Type:
boolean
(optional, default: undefined)
Whether to enable or disable cold storage on the domain.
You must enable UltraWarm storage to enable cold storage.
customEndpoint?
Type:
Custom
(optional, default: no custom domain endpoint will be configured)
To configure a custom domain configure these options.
If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate
domainName?
Type:
string
(optional, default: A name will be auto-generated.)
Enforces a particular physical domain name.
ebs?
Type:
Ebs
(optional, default: 10 GiB General Purpose (SSD) volumes per node.)
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.
enableAutoSoftwareUpdate?
Type:
boolean
(optional, default: false)
Specifies whether automatic service software updates are enabled for the domain.
enableVersionUpgrade?
Type:
boolean
(optional, default: false)
To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.
encryptionAtRest?
Type:
Encryption
(optional, default: No encryption at rest)
Encryption at rest options for the cluster.
enforceHttps?
Type:
boolean
(optional, default: false)
True to require that all traffic to the domain arrive over HTTPS.
fineGrainedAccessControl?
Type:
Advanced
(optional, default: fine-grained access control is disabled)
Specifies options for fine-grained access control.
Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 or later. Enabling fine-grained access control also requires encryption of data at rest and node-to-node encryption, along with enforced HTTPS.
ipAddressType?
Type:
Ip
(optional, default: IpAddressType.IPV4)
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.
logging?
Type:
Logging
(optional, default: No logs are published)
Configuration log publishing configuration options.
nodeToNodeEncryption?
Type:
boolean
(optional, default: Node to node encryption is not enabled.)
Specify true to enable node to node encryption.
Requires Elasticsearch version 6.0 or later or OpenSearch version 1.0 or later.
offPeakWindowEnabled?
Type:
boolean
(optional, default: Disabled for domains created before February 16, 2023. Enabled for domains created after. Enabled if offPeakWindowStart
is set.)
Options for enabling a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
Off-peak windows were introduced on February 16, 2023. All domains created before this date have the off-peak window disabled by default. You must manually enable and configure the off-peak window for these domains. All domains created after this date will have the off-peak window enabled by default. You can't disable the off-peak window for a domain after it's enabled.
offPeakWindowStart?
Type:
Window
(optional, default: 10:00 P.M. local time)
Start time for the off-peak window, in Coordinated Universal Time (UTC).
The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
removalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.RETAIN)
Policy to apply when the domain is removed from the stack.
securityGroups?
Type:
ISecurity
[]
(optional, default: One new security group is created.)
The list of security groups that are associated with the VPC endpoints for the domain.
Only used if vpc
is specified.
See also: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html
suppressLogsResourcePolicy?
Type:
boolean
(optional, default: false)
Specify whether to create a CloudWatch Logs resource policy or not.
When logging is enabled for the domain, a CloudWatch Logs resource policy is created by default. However, CloudWatch Logs supports only 10 resource policies per region. If you enable logging for several domains, it may hit the quota and cause an error. By setting this property to true, creating a resource policy is suppressed, allowing you to avoid this problem.
If you set this option to true, you must create a resource policy before deployment.
tlsSecurityPolicy?
Type:
TLSSecurity
(optional, default: TLSSecurityPolicy.TLS_1_0)
The minimum TLS version required for traffic to the domain.
useUnsignedBasicAuth?
Type:
boolean
(optional, default: false)
Configures the domain so that unsigned basic auth is enabled.
If no master user is provided a default master user
with username admin
and a dynamically generated password stored in KMS is created. The password can be retrieved
by getting masterUserPassword
from the domain instance.
Setting this to true will also add an access policy that allows unsigned access, enable node to node encryption, encryption at rest. If conflicting settings are encountered (like disabling encryption at rest) enabling this setting will cause a failure.
vpc?
Type:
IVpc
(optional, default: Domain is not placed in a VPC.)
Place the domain inside this VPC.
See also: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
vpcSubnets?
Type:
Subnet
[]
(optional, default: All private subnets.)
The specific vpc subnets the domain will be placed in.
You must provide one subnet for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain.
Only used if vpc
is specified.
See also: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
zoneAwareness?
Type:
Zone
(optional, default: no zone awareness (1 AZ))
The cluster zone awareness configuration for the Amazon OpenSearch Service domain.