software.amazon.awscdk.services.elasticsearch

Class DomainProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticsearch.DomainProps.Jsii$Proxy

All Implemented Interfaces:

DomainProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DomainProps

@Stability(value=Experimental)
 @Internal
public static final class DomainProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DomainProps

An implementation for DomainProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticsearch.DomainProps

DomainProps.Builder, DomainProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(ElasticsearchVersion version, List<? extends PolicyStatement> accessPolicies, Map<String,String> advancedOptions, Number automatedSnapshotStartHour, CapacityConfig capacity, CognitoOptions cognitoKibanaAuth, CustomEndpointOptions customEndpoint, String domainName, EbsOptions ebs, Boolean enableVersionUpgrade, EncryptionAtRestOptions encryptionAtRest, Boolean enforceHttps, AdvancedSecurityOptions fineGrainedAccessControl, LoggingOptions logging, Boolean nodeToNodeEncryption, RemovalPolicy removalPolicy, List<? extends ISecurityGroup> securityGroups, TLSSecurityPolicy tlsSecurityPolicy, Boolean useUnsignedBasicAuth, IVpc vpc, List<? extends SubnetSelection> vpcSubnets, ZoneAwarenessConfig zoneAwareness) Constructor that initializes the object based on literal property values passed by the DomainProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
List<PolicyStatement>	getAccessPolicies() (experimental) Domain Access policies.
Map<String,String>	getAdvancedOptions() (experimental) Additional options to specify for the Amazon ES domain.
Number	getAutomatedSnapshotStartHour() (experimental) The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon ES domain.
CapacityConfig	getCapacity() (experimental) The cluster capacity configuration for the Amazon ES domain.
CognitoOptions	getCognitoKibanaAuth() (experimental) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
CustomEndpointOptions	getCustomEndpoint() (experimental) To configure a custom domain configure these options.
String	getDomainName() (experimental) Enforces a particular physical domain name.
EbsOptions	getEbs() (experimental) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.
Boolean	getEnableVersionUpgrade() (experimental) To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy.
EncryptionAtRestOptions	getEncryptionAtRest() (experimental) Encryption at rest options for the cluster.
Boolean	getEnforceHttps() (experimental) True to require that all traffic to the domain arrive over HTTPS.
AdvancedSecurityOptions	getFineGrainedAccessControl() (experimental) Specifies options for fine-grained access control.
LoggingOptions	getLogging() (experimental) Configuration log publishing configuration options.
Boolean	getNodeToNodeEncryption() (experimental) Specify true to enable node to node encryption.
RemovalPolicy	getRemovalPolicy() (experimental) Policy to apply when the domain is removed from the stack.
List<ISecurityGroup>	getSecurityGroups() (experimental) The list of security groups that are associated with the VPC endpoints for the domain.
TLSSecurityPolicy	getTlsSecurityPolicy() (experimental) The minimum TLS version required for traffic to the domain.
Boolean	getUseUnsignedBasicAuth() (experimental) Configures the domain so that unsigned basic auth is enabled.
ElasticsearchVersion	getVersion() (experimental) The Elasticsearch version that your domain will leverage.
IVpc	getVpc() (experimental) Place the domain inside this VPC.
List<SubnetSelection>	getVpcSubnets() (experimental) The specific vpc subnets the domain will be placed in.
ZoneAwarenessConfig	getZoneAwareness() (experimental) The cluster zone awareness configuration for the Amazon ES domain.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.elasticsearch.DomainProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ElasticsearchVersion version,
                     List<? extends PolicyStatement> accessPolicies,
                     Map<String,String> advancedOptions,
                     Number automatedSnapshotStartHour,
                     CapacityConfig capacity,
                     CognitoOptions cognitoKibanaAuth,
                     CustomEndpointOptions customEndpoint,
                     String domainName,
                     EbsOptions ebs,
                     Boolean enableVersionUpgrade,
                     EncryptionAtRestOptions encryptionAtRest,
                     Boolean enforceHttps,
                     AdvancedSecurityOptions fineGrainedAccessControl,
                     LoggingOptions logging,
                     Boolean nodeToNodeEncryption,
                     RemovalPolicy removalPolicy,
                     List<? extends ISecurityGroup> securityGroups,
                     TLSSecurityPolicy tlsSecurityPolicy,
                     Boolean useUnsignedBasicAuth,
                     IVpc vpc,
                     List<? extends SubnetSelection> vpcSubnets,
                     ZoneAwarenessConfig zoneAwareness)

Constructor that initializes the object based on literal property values passed by the DomainProps.Builder.

Method Detail

getVersion

public final ElasticsearchVersion getVersion()

Description copied from interface: DomainProps

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

Specified by:

getVersion in interface DomainProps

getAccessPolicies

public final List<PolicyStatement> getAccessPolicies()

Description copied from interface: DomainProps

(experimental) Domain Access policies.

Default: - No access policies.

Specified by:

getAccessPolicies in interface DomainProps

getAdvancedOptions

public final Map<String,String> getAdvancedOptions()

Description copied from interface: DomainProps

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

Default: - no advanced options are specified

Specified by:

getAdvancedOptions in interface DomainProps

getAutomatedSnapshotStartHour

public final Number getAutomatedSnapshotStartHour()

Description copied from interface: DomainProps

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

Specified by:

getAutomatedSnapshotStartHour in interface DomainProps

getCapacity

public final CapacityConfig getCapacity()

Description copied from interface: DomainProps

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

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

Specified by:

getCapacity in interface DomainProps

getCognitoKibanaAuth

public final CognitoOptions getCognitoKibanaAuth()

Description copied from interface: DomainProps

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

Default: - Cognito not used for authentication to Kibana.

Specified by:

getCognitoKibanaAuth in interface DomainProps

getCustomEndpoint

public final CustomEndpointOptions getCustomEndpoint()

Description copied from interface: DomainProps

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

Specified by:

getCustomEndpoint in interface DomainProps

getDomainName

public final String getDomainName()

Description copied from interface: DomainProps

(experimental) Enforces a particular physical domain name.

Default: - A name will be auto-generated.

Specified by:

getDomainName in interface DomainProps

getEbs

public final EbsOptions getEbs()

Description copied from interface: DomainProps

(experimental) 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.

Specified by:

getEbs in interface DomainProps

getEnableVersionUpgrade

public final Boolean getEnableVersionUpgrade()

Description copied from interface: DomainProps

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

Specified by:

getEnableVersionUpgrade in interface DomainProps

See Also:

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

getEncryptionAtRest

public final EncryptionAtRestOptions getEncryptionAtRest()

Description copied from interface: DomainProps

(experimental) Encryption at rest options for the cluster.

Default: - No encryption at rest

Specified by:

getEncryptionAtRest in interface DomainProps

getEnforceHttps

public final Boolean getEnforceHttps()

Description copied from interface: DomainProps

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

Default: - false

Specified by:

getEnforceHttps in interface DomainProps

getFineGrainedAccessControl

public final AdvancedSecurityOptions getFineGrainedAccessControl()

Description copied from interface: DomainProps

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

Specified by:

getFineGrainedAccessControl in interface DomainProps

getLogging

public final LoggingOptions getLogging()

Description copied from interface: DomainProps

(experimental) Configuration log publishing configuration options.

Default: - No logs are published

Specified by:

getLogging in interface DomainProps

getNodeToNodeEncryption

public final Boolean getNodeToNodeEncryption()

Description copied from interface: DomainProps

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

Requires Elasticsearch version 6.0 or later.

Default: - Node to node encryption is not enabled.

Specified by:

getNodeToNodeEncryption in interface DomainProps

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: DomainProps

(experimental) Policy to apply when the domain is removed from the stack.

Default: RemovalPolicy.RETAIN

Specified by:

getRemovalPolicy in interface DomainProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: DomainProps

(experimental) 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.

Specified by:

getSecurityGroups in interface DomainProps

See Also:

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

getTlsSecurityPolicy

public final TLSSecurityPolicy getTlsSecurityPolicy()

Description copied from interface: DomainProps

(experimental) The minimum TLS version required for traffic to the domain.

Default: - TLSSecurityPolicy.TLS_1_0

Specified by:

getTlsSecurityPolicy in interface DomainProps

getUseUnsignedBasicAuth

public final Boolean getUseUnsignedBasicAuth()

Description copied from interface: DomainProps

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

Specified by:

getUseUnsignedBasicAuth in interface DomainProps

getVpc

public final IVpc getVpc()

Description copied from interface: DomainProps

(experimental) Place the domain inside this VPC.

Default: - Domain is not placed in a VPC.

Specified by:

getVpc in interface DomainProps

See Also:

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

getVpcSubnets

public final List<SubnetSelection> getVpcSubnets()

Description copied from interface: DomainProps

(experimental) 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.

Specified by:

getVpcSubnets in interface DomainProps

See Also:

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

getZoneAwareness

public final ZoneAwarenessConfig getZoneAwareness()

Description copied from interface: DomainProps

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

Default: - no zone awareness (1 AZ)

Specified by:

getZoneAwareness in interface DomainProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object