software.amazon.awscdk.services.opensearchservice

Class Domain.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.Domain.Builder

Enclosing class:

Domain

public static final class Domain.Builder
extends java.lang.Object

A fluent builder for Domain.

Method Summary

Modifier and Type	Method and Description
Domain.Builder	accessPolicies(java.util.List<? extends PolicyStatement> accessPolicies) Domain access policies.
Domain.Builder	advancedOptions(java.util.Map<java.lang.String,java.lang.String> advancedOptions) Additional options to specify for the Amazon OpenSearch Service domain.
Domain.Builder	automatedSnapshotStartHour(java.lang.Number automatedSnapshotStartHour) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain.
Domain	build()
Domain.Builder	capacity(CapacityConfig capacity) The cluster capacity configuration for the Amazon OpenSearch Service domain.
Domain.Builder	cognitoDashboardsAuth(CognitoOptions cognitoDashboardsAuth) Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
static Domain.Builder	create(software.constructs.Construct scope, java.lang.String id)
Domain.Builder	customEndpoint(CustomEndpointOptions customEndpoint) To configure a custom domain configure these options.
Domain.Builder	domainName(java.lang.String domainName) Enforces a particular physical domain name.
Domain.Builder	ebs(EbsOptions ebs) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.
Domain.Builder	enableVersionUpgrade(java.lang.Boolean enableVersionUpgrade) To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.
Domain.Builder	encryptionAtRest(EncryptionAtRestOptions encryptionAtRest) Encryption at rest options for the cluster.
Domain.Builder	enforceHttps(java.lang.Boolean enforceHttps) True to require that all traffic to the domain arrive over HTTPS.
Domain.Builder	fineGrainedAccessControl(AdvancedSecurityOptions fineGrainedAccessControl) Specifies options for fine-grained access control.
Domain.Builder	logging(LoggingOptions logging) Configuration log publishing configuration options.
Domain.Builder	nodeToNodeEncryption(java.lang.Boolean nodeToNodeEncryption) Specify true to enable node to node encryption.
Domain.Builder	removalPolicy(RemovalPolicy removalPolicy) Policy to apply when the domain is removed from the stack.
Domain.Builder	securityGroups(java.util.List<? extends ISecurityGroup> securityGroups) The list of security groups that are associated with the VPC endpoints for the domain.
Domain.Builder	tlsSecurityPolicy(TLSSecurityPolicy tlsSecurityPolicy) The minimum TLS version required for traffic to the domain.
Domain.Builder	useUnsignedBasicAuth(java.lang.Boolean useUnsignedBasicAuth) Configures the domain so that unsigned basic auth is enabled.
Domain.Builder	version(EngineVersion version) The Elasticsearch/OpenSearch version that your domain will leverage.
Domain.Builder	vpc(IVpc vpc) Place the domain inside this VPC.
Domain.Builder	vpcSubnets(java.util.List<? extends SubnetSelection> vpcSubnets) The specific vpc subnets the domain will be placed in.
Domain.Builder	zoneAwareness(ZoneAwarenessConfig zoneAwareness) The cluster zone awareness configuration for the Amazon OpenSearch Service domain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Domain.Builder create(software.constructs.Construct scope,
                                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Domain.Builder.

version

public Domain.Builder version(EngineVersion version)

The Elasticsearch/OpenSearch version that your domain will leverage.

Parameters:

version - The Elasticsearch/OpenSearch version that your domain will leverage. This parameter is required.

Returns:

this

accessPolicies

public Domain.Builder accessPolicies(java.util.List<? extends PolicyStatement> accessPolicies)

Domain access policies.

Default: - No access policies.

Parameters:

accessPolicies - Domain access policies. This parameter is required.

Returns:

this

advancedOptions

public Domain.Builder advancedOptions(java.util.Map<java.lang.String,java.lang.String> advancedOptions)

Additional options to specify for the Amazon OpenSearch Service domain.

Default: - no advanced options are specified

Parameters:

advancedOptions - Additional options to specify for the Amazon OpenSearch Service domain. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options

automatedSnapshotStartHour

public Domain.Builder automatedSnapshotStartHour(java.lang.Number automatedSnapshotStartHour)

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.

Default: - Hourly automated snapshots not used

Parameters:

automatedSnapshotStartHour - The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain. This parameter is required.

Returns:

this

capacity

public Domain.Builder capacity(CapacityConfig capacity)

The cluster capacity configuration for the Amazon OpenSearch Service domain.

Default: - 1 r5.large.search data node; no dedicated master nodes.

Parameters:

capacity - The cluster capacity configuration for the Amazon OpenSearch Service domain. This parameter is required.

Returns:

this

cognitoDashboardsAuth

public Domain.Builder cognitoDashboardsAuth(CognitoOptions cognitoDashboardsAuth)

Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Default: - Cognito not used for authentication to OpenSearch Dashboards.

Parameters:

cognitoDashboardsAuth - Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. This parameter is required.

Returns:

this

customEndpoint

public Domain.Builder customEndpoint(CustomEndpointOptions customEndpoint)

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

Default: - no custom domain endpoint will be configured

Parameters:

customEndpoint - To configure a custom domain configure these options. This parameter is required.

Returns:

this

domainName

public Domain.Builder domainName(java.lang.String domainName)

Enforces a particular physical domain name.

Default: - A name will be auto-generated.

Parameters:

domainName - Enforces a particular physical domain name. This parameter is required.

Returns:

this

ebs

public Domain.Builder ebs(EbsOptions ebs)

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

Default: - 10 GiB General Purpose (SSD) volumes per node.

Parameters:

ebs - The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain. This parameter is required.

Returns:

this

enableVersionUpgrade

public Domain.Builder enableVersionUpgrade(java.lang.Boolean enableVersionUpgrade)

To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.

Default: - false

Parameters:

enableVersionUpgrade - To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain

encryptionAtRest

public Domain.Builder encryptionAtRest(EncryptionAtRestOptions encryptionAtRest)

Encryption at rest options for the cluster.

Default: - No encryption at rest

Parameters:

encryptionAtRest - Encryption at rest options for the cluster. This parameter is required.

Returns:

this

enforceHttps

public Domain.Builder enforceHttps(java.lang.Boolean enforceHttps)

True to require that all traffic to the domain arrive over HTTPS.

Default: - false

Parameters:

enforceHttps - True to require that all traffic to the domain arrive over HTTPS. This parameter is required.

Returns:

this

fineGrainedAccessControl

public Domain.Builder fineGrainedAccessControl(AdvancedSecurityOptions fineGrainedAccessControl)

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.

Default: - fine-grained access control is disabled

Parameters:

fineGrainedAccessControl - Specifies options for fine-grained access control. This parameter is required.

Returns:

this

logging

public Domain.Builder logging(LoggingOptions logging)

Configuration log publishing configuration options.

Default: - No logs are published

Parameters:

logging - Configuration log publishing configuration options. This parameter is required.

Returns:

this

nodeToNodeEncryption

public Domain.Builder nodeToNodeEncryption(java.lang.Boolean nodeToNodeEncryption)

Specify true to enable node to node encryption.

Requires Elasticsearch version 6.0 or later or OpenSearch version 1.0 or later.

Default: - Node to node encryption is not enabled.

Parameters:

nodeToNodeEncryption - Specify true to enable node to node encryption. This parameter is required.

Returns:

this

removalPolicy

public Domain.Builder removalPolicy(RemovalPolicy removalPolicy)

Policy to apply when the domain is removed from the stack.

Default: RemovalPolicy.RETAIN

Parameters:

removalPolicy - Policy to apply when the domain is removed from the stack. This parameter is required.

Returns:

this

securityGroups

public Domain.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)

The list of security groups that are associated with the VPC endpoints for the domain.

Only used if vpc is specified.

Default: - One new security group is created.

Parameters:

securityGroups - The list of security groups that are associated with the VPC endpoints for the domain. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html

tlsSecurityPolicy

public Domain.Builder tlsSecurityPolicy(TLSSecurityPolicy tlsSecurityPolicy)

The minimum TLS version required for traffic to the domain.

Default: - TLSSecurityPolicy.TLS_1_0

Parameters:

tlsSecurityPolicy - The minimum TLS version required for traffic to the domain. This parameter is required.

Returns:

this

useUnsignedBasicAuth

public Domain.Builder useUnsignedBasicAuth(java.lang.Boolean useUnsignedBasicAuth)

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.

Default: - false

Parameters:

useUnsignedBasicAuth - Configures the domain so that unsigned basic auth is enabled. This parameter is required.

Returns:

this

vpc

public Domain.Builder vpc(IVpc vpc)

Place the domain inside this VPC.

Default: - Domain is not placed in a VPC.

Parameters:

vpc - Place the domain inside this VPC. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html

vpcSubnets

public Domain.Builder vpcSubnets(java.util.List<? extends SubnetSelection> vpcSubnets)

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.

Default: - All private subnets.

Parameters:

vpcSubnets - The specific vpc subnets the domain will be placed in. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html

zoneAwareness

public Domain.Builder zoneAwareness(ZoneAwarenessConfig zoneAwareness)

The cluster zone awareness configuration for the Amazon OpenSearch Service domain.

Default: - no zone awareness (1 AZ)

Parameters:

zoneAwareness - The cluster zone awareness configuration for the Amazon OpenSearch Service domain. This parameter is required.

Returns:

this

build

public Domain build()