software.amazon.awscdk.services.elasticsearch

Class Domain.Builder

java.lang.Object

software.amazon.awscdk.services.elasticsearch.Domain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Domain>

Enclosing class:

Domain

Deprecated.

@Stability(value=Deprecated)
 @Deprecated
public static final class Domain.Builder
extends Object
implements software.amazon.jsii.Builder<Domain>

(deprecated) A fluent builder for Domain.

Method Summary

Modifier and Type	Method and Description
Domain.Builder	accessPolicies(List<? extends PolicyStatement> accessPolicies) Deprecated. use opensearchservice module instead
Domain.Builder	advancedOptions(Map<String,String> advancedOptions) Deprecated. use opensearchservice module instead
Domain.Builder	automatedSnapshotStartHour(Number automatedSnapshotStartHour) Deprecated. use opensearchservice module instead
Domain	build() Deprecated.
Domain.Builder	capacity(CapacityConfig capacity) Deprecated. use opensearchservice module instead
Domain.Builder	cognitoKibanaAuth(CognitoOptions cognitoKibanaAuth) Deprecated. use opensearchservice module instead
static Domain.Builder	create(software.constructs.Construct scope, String id) Deprecated.
Domain.Builder	customEndpoint(CustomEndpointOptions customEndpoint) Deprecated. use opensearchservice module instead
Domain.Builder	domainName(String domainName) Deprecated. use opensearchservice module instead
Domain.Builder	ebs(EbsOptions ebs) Deprecated. use opensearchservice module instead
Domain.Builder	enableVersionUpgrade(Boolean enableVersionUpgrade) Deprecated. use opensearchservice module instead
Domain.Builder	encryptionAtRest(EncryptionAtRestOptions encryptionAtRest) Deprecated. use opensearchservice module instead
Domain.Builder	enforceHttps(Boolean enforceHttps) Deprecated. use opensearchservice module instead
Domain.Builder	fineGrainedAccessControl(AdvancedSecurityOptions fineGrainedAccessControl) Deprecated. use opensearchservice module instead
Domain.Builder	logging(LoggingOptions logging) Deprecated. use opensearchservice module instead
Domain.Builder	nodeToNodeEncryption(Boolean nodeToNodeEncryption) Deprecated. use opensearchservice module instead
Domain.Builder	removalPolicy(RemovalPolicy removalPolicy) Deprecated. use opensearchservice module instead
Domain.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) Deprecated. use opensearchservice module instead
Domain.Builder	tlsSecurityPolicy(TLSSecurityPolicy tlsSecurityPolicy) Deprecated. use opensearchservice module instead
Domain.Builder	useUnsignedBasicAuth(Boolean useUnsignedBasicAuth) Deprecated. use opensearchservice module instead
Domain.Builder	version(ElasticsearchVersion version) Deprecated. use opensearchservice module instead
Domain.Builder	vpc(IVpc vpc) Deprecated. use opensearchservice module instead
Domain.Builder	vpcSubnets(List<? extends SubnetSelection> vpcSubnets) Deprecated. use opensearchservice module instead
Domain.Builder	zoneAwareness(ZoneAwarenessConfig zoneAwareness) Deprecated. use opensearchservice module instead

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Deprecated)
 @Deprecated
public static Domain.Builder create(software.constructs.Construct scope,
                                                                              String id)

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Domain.Builder.

version

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder version(ElasticsearchVersion version)

Deprecated. use opensearchservice module instead

(deprecated) The Elasticsearch version that your domain will leverage.

Parameters:

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

Returns:

this

accessPolicies

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder accessPolicies(List<? extends PolicyStatement> accessPolicies)

Deprecated. use opensearchservice module instead

(deprecated) Domain Access policies.

Default: - No access policies.

Parameters:

accessPolicies - Domain Access policies. This parameter is required.

Returns:

this

advancedOptions

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder advancedOptions(Map<String,String> advancedOptions)

Deprecated. use opensearchservice module instead

(deprecated) Additional options to specify for the Amazon ES domain.

Default: - no advanced options are specified

Parameters:

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

Returns:

this

See Also:

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

automatedSnapshotStartHour

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder automatedSnapshotStartHour(Number automatedSnapshotStartHour)

Deprecated. use opensearchservice module instead

(deprecated) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES 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 ES domain. This parameter is required.

Returns:

this

capacity

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder capacity(CapacityConfig capacity)

Deprecated. use opensearchservice module instead

(deprecated) The cluster capacity configuration for the Amazon ES domain.

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

Parameters:

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

Returns:

this

cognitoKibanaAuth

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder cognitoKibanaAuth(CognitoOptions cognitoKibanaAuth)

Deprecated. use opensearchservice module instead

(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.

Default: - Cognito not used for authentication to Kibana.

Parameters:

cognitoKibanaAuth - Configures Amazon ES to use Amazon Cognito authentication for Kibana. This parameter is required.

Returns:

this

customEndpoint

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder customEndpoint(CustomEndpointOptions customEndpoint)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder domainName(String domainName)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder ebs(EbsOptions ebs)

Deprecated. use opensearchservice module instead

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

For more information, see [Configuring EBS-based Storage] (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the Amazon Elasticsearch Service Developer Guide.

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 ES domain. This parameter is required.

Returns:

this

enableVersionUpgrade

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder enableVersionUpgrade(Boolean enableVersionUpgrade)

Deprecated. use opensearchservice module instead

(deprecated) To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.

Default: - false

Parameters:

enableVersionUpgrade - To upgrade an Amazon ES domain to a new version of Elasticsearch 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-upgradeelasticsearchdomain

encryptionAtRest

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder encryptionAtRest(EncryptionAtRestOptions encryptionAtRest)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder enforceHttps(Boolean enforceHttps)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder fineGrainedAccessControl(AdvancedSecurityOptions fineGrainedAccessControl)

Deprecated. use opensearchservice module instead

(deprecated) Specifies options for fine-grained access control.

Requires Elasticsearch version 6.7 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder logging(LoggingOptions logging)

Deprecated. use opensearchservice module instead

(deprecated) Configuration log publishing configuration options.

Default: - No logs are published

Parameters:

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

Returns:

this

nodeToNodeEncryption

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder nodeToNodeEncryption(Boolean nodeToNodeEncryption)

Deprecated. use opensearchservice module instead

(deprecated) Specify true to enable node to node encryption.

Requires Elasticsearch version 6.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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder removalPolicy(RemovalPolicy removalPolicy)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder tlsSecurityPolicy(TLSSecurityPolicy tlsSecurityPolicy)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder useUnsignedBasicAuth(Boolean useUnsignedBasicAuth)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder vpc(IVpc vpc)

Deprecated. use opensearchservice module instead

(deprecated) 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/elasticsearch-service/latest/developerguide/es-vpc.html

vpcSubnets

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Deprecated. use opensearchservice module instead

(deprecated) 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

@Stability(value=Deprecated)
 @Deprecated
public Domain.Builder zoneAwareness(ZoneAwarenessConfig zoneAwareness)

Deprecated. use opensearchservice module instead

(deprecated) The cluster zone awareness configuration for the Amazon ES domain.

Default: - no zone awareness (1 AZ)

Parameters:

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

Returns:

this

build

@Stability(value=Deprecated)
 @Deprecated
public Domain build()

Deprecated.

Specified by:

build in interface software.amazon.jsii.Builder<Domain>