Modifier and Type | Method and Description |
---|---|
CfnDomain.Builder |
accessPolicies(java.lang.Object accessPolicies)
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
|
CfnDomain.Builder |
advancedOptions(IResolvable advancedOptions)
Additional options to specify for the OpenSearch Service domain.
|
CfnDomain.Builder |
advancedOptions(java.util.Map<java.lang.String,java.lang.String> advancedOptions)
Additional options to specify for the OpenSearch Service domain.
|
CfnDomain.Builder |
advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)
Specifies options for fine-grained access control.
|
CfnDomain.Builder |
advancedSecurityOptions(IResolvable advancedSecurityOptions)
Specifies options for fine-grained access control.
|
CfnDomain |
build() |
CfnDomain.Builder |
clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)
Container for the cluster configuration of a domain.
|
CfnDomain.Builder |
clusterConfig(IResolvable clusterConfig)
Container for the cluster configuration of a domain.
|
CfnDomain.Builder |
cognitoOptions(CfnDomain.CognitoOptionsProperty cognitoOptions)
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
|
CfnDomain.Builder |
cognitoOptions(IResolvable cognitoOptions)
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
|
static CfnDomain.Builder |
create(Construct scope,
java.lang.String id) |
CfnDomain.Builder |
domainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty domainEndpointOptions)
Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
|
CfnDomain.Builder |
domainEndpointOptions(IResolvable domainEndpointOptions)
Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
|
CfnDomain.Builder |
domainName(java.lang.String domainName)
A name for the OpenSearch Service domain.
|
CfnDomain.Builder |
ebsOptions(CfnDomain.EBSOptionsProperty ebsOptions)
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
|
CfnDomain.Builder |
ebsOptions(IResolvable ebsOptions)
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
|
CfnDomain.Builder |
encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty encryptionAtRestOptions)
Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
|
CfnDomain.Builder |
encryptionAtRestOptions(IResolvable encryptionAtRestOptions)
Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
|
CfnDomain.Builder |
engineVersion(java.lang.String engineVersion)
The version of OpenSearch to use.
|
CfnDomain.Builder |
logPublishingOptions(IResolvable logPublishingOptions)
An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
|
CfnDomain.Builder |
logPublishingOptions(java.util.Map<java.lang.String,? extends java.lang.Object> logPublishingOptions)
An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish.
|
CfnDomain.Builder |
nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)
Specifies whether node-to-node encryption is enabled.
|
CfnDomain.Builder |
nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)
Specifies whether node-to-node encryption is enabled.
|
CfnDomain.Builder |
snapshotOptions(CfnDomain.SnapshotOptionsProperty snapshotOptions)
*DEPRECATED* .
|
CfnDomain.Builder |
snapshotOptions(IResolvable snapshotOptions)
*DEPRECATED* .
|
CfnDomain.Builder |
tags(java.util.List<? extends CfnTag> tags)
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
|
CfnDomain.Builder |
vpcOptions(CfnDomain.VPCOptionsProperty vpcOptions)
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
|
CfnDomain.Builder |
vpcOptions(IResolvable vpcOptions)
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
|
public static CfnDomain.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnDomain.AdvancedSecurityOptionsInputProperty.Builder
.public CfnDomain.Builder accessPolicies(java.lang.Object accessPolicies)
For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .
accessPolicies
- An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. This parameter is required.this
public CfnDomain.Builder advancedOptions(IResolvable advancedOptions)
For more information, see AdvancedOptions in the OpenSearch Service API reference.
advancedOptions
- Additional options to specify for the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder advancedOptions(java.util.Map<java.lang.String,java.lang.String> advancedOptions)
For more information, see AdvancedOptions in the OpenSearch Service API reference.
advancedOptions
- Additional options to specify for the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder advancedSecurityOptions(IResolvable advancedSecurityOptions)
If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS
within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.
advancedSecurityOptions
- Specifies options for fine-grained access control. This parameter is required.this
public CfnDomain.Builder advancedSecurityOptions(CfnDomain.AdvancedSecurityOptionsInputProperty advancedSecurityOptions)
If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS
within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.
advancedSecurityOptions
- Specifies options for fine-grained access control. This parameter is required.this
public CfnDomain.Builder clusterConfig(IResolvable clusterConfig)
clusterConfig
- Container for the cluster configuration of a domain. This parameter is required.this
public CfnDomain.Builder clusterConfig(CfnDomain.ClusterConfigProperty clusterConfig)
clusterConfig
- Container for the cluster configuration of a domain. This parameter is required.this
public CfnDomain.Builder cognitoOptions(IResolvable cognitoOptions)
cognitoOptions
- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. This parameter is required.this
public CfnDomain.Builder cognitoOptions(CfnDomain.CognitoOptionsProperty cognitoOptions)
cognitoOptions
- Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. This parameter is required.this
public CfnDomain.Builder domainEndpointOptions(IResolvable domainEndpointOptions)
domainEndpointOptions
- Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint. This parameter is required.this
public CfnDomain.Builder domainEndpointOptions(CfnDomain.DomainEndpointOptionsProperty domainEndpointOptions)
domainEndpointOptions
- Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint. This parameter is required.this
public CfnDomain.Builder domainName(java.lang.String domainName)
The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .
Required when creating a new domain.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
domainName
- A name for the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder ebsOptions(IResolvable ebsOptions)
For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
ebsOptions
- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder ebsOptions(CfnDomain.EBSOptionsProperty ebsOptions)
For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
ebsOptions
- The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder encryptionAtRestOptions(IResolvable encryptionAtRestOptions)
See Encryption of data at rest for Amazon OpenSearch Service .
encryptionAtRestOptions
- Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. This parameter is required.this
public CfnDomain.Builder encryptionAtRestOptions(CfnDomain.EncryptionAtRestOptionsProperty encryptionAtRestOptions)
See Encryption of data at rest for Amazon OpenSearch Service .
encryptionAtRestOptions
- Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. This parameter is required.this
public CfnDomain.Builder engineVersion(java.lang.String engineVersion)
The value must be in the format OpenSearch_X.Y
or Elasticsearch_X.Y
. If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .
If you set the EnableVersionUpgrade update policy to true
, you can update EngineVersion
without interruption. When EnableVersionUpgrade
is set to false
, or is not specified, updating EngineVersion
results in replacement .
engineVersion
- The version of OpenSearch to use. This parameter is required.this
public CfnDomain.Builder logPublishingOptions(IResolvable logPublishingOptions)
Each key needs a valid LogPublishingOption
value. For the full syntax, see the examples .
logPublishingOptions
- An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish. This parameter is required.this
public CfnDomain.Builder logPublishingOptions(java.util.Map<java.lang.String,? extends java.lang.Object> logPublishingOptions)
Each key needs a valid LogPublishingOption
value. For the full syntax, see the examples .
logPublishingOptions
- An object with one or more of the following keys: `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , `AUDIT_LOGS` , depending on the types of logs you want to publish. This parameter is required.this
public CfnDomain.Builder nodeToNodeEncryptionOptions(IResolvable nodeToNodeEncryptionOptions)
nodeToNodeEncryptionOptions
- Specifies whether node-to-node encryption is enabled. This parameter is required.this
public CfnDomain.Builder nodeToNodeEncryptionOptions(CfnDomain.NodeToNodeEncryptionOptionsProperty nodeToNodeEncryptionOptions)
nodeToNodeEncryptionOptions
- Specifies whether node-to-node encryption is enabled. This parameter is required.this
public CfnDomain.Builder snapshotOptions(IResolvable snapshotOptions)
The automated snapshot configuration for the OpenSearch Service domain indexes.
snapshotOptions
- *DEPRECATED* . This parameter is required.this
public CfnDomain.Builder snapshotOptions(CfnDomain.SnapshotOptionsProperty snapshotOptions)
The automated snapshot configuration for the OpenSearch Service domain indexes.
snapshotOptions
- *DEPRECATED* . This parameter is required.this
public CfnDomain.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder vpcOptions(IResolvable vpcOptions)
For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.
vpcOptions
- The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.this
public CfnDomain.Builder vpcOptions(CfnDomain.VPCOptionsProperty vpcOptions)
For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .
If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.
vpcOptions
- The virtual private cloud (VPC) configuration for the OpenSearch Service domain. This parameter is required.this
public CfnDomain build()