Class DomainProps.Builder
java.lang.Object
software.amazon.awscdk.services.elasticsearch.DomainProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DomainProps>
- Enclosing interface:
DomainProps
@Stability(Deprecated)
@Deprecated
public static final class DomainProps.Builder
extends Object
implements software.amazon.jsii.Builder<DomainProps>
Deprecated.
A builder for
DomainProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaccessPolicies
(List<? extends PolicyStatement> accessPolicies) Deprecated.use opensearchservice module insteadadvancedOptions
(Map<String, String> advancedOptions) Deprecated.use opensearchservice module insteadautomatedSnapshotStartHour
(Number automatedSnapshotStartHour) Deprecated.use opensearchservice module insteadbuild()
Deprecated.capacity
(CapacityConfig capacity) Deprecated.use opensearchservice module insteadcognitoKibanaAuth
(CognitoOptions cognitoKibanaAuth) Deprecated.use opensearchservice module insteadcustomEndpoint
(CustomEndpointOptions customEndpoint) Deprecated.use opensearchservice module insteaddomainName
(String domainName) Deprecated.use opensearchservice module insteadebs
(EbsOptions ebs) Deprecated.use opensearchservice module insteadenableVersionUpgrade
(Boolean enableVersionUpgrade) Deprecated.use opensearchservice module insteadencryptionAtRest
(EncryptionAtRestOptions encryptionAtRest) Deprecated.use opensearchservice module insteadenforceHttps
(Boolean enforceHttps) Deprecated.use opensearchservice module insteadfineGrainedAccessControl
(AdvancedSecurityOptions fineGrainedAccessControl) Deprecated.use opensearchservice module insteadlogging
(LoggingOptions logging) Deprecated.use opensearchservice module insteadnodeToNodeEncryption
(Boolean nodeToNodeEncryption) Deprecated.use opensearchservice module insteadremovalPolicy
(RemovalPolicy removalPolicy) Deprecated.use opensearchservice module insteadsecurityGroups
(List<? extends ISecurityGroup> securityGroups) Deprecated.use opensearchservice module insteadtlsSecurityPolicy
(TLSSecurityPolicy tlsSecurityPolicy) Deprecated.use opensearchservice module insteaduseUnsignedBasicAuth
(Boolean useUnsignedBasicAuth) Deprecated.use opensearchservice module insteadversion
(ElasticsearchVersion version) Deprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadvpcSubnets
(List<? extends SubnetSelection> vpcSubnets) Deprecated.use opensearchservice module insteadzoneAwareness
(ZoneAwarenessConfig zoneAwareness) Deprecated.use opensearchservice module instead
-
Constructor Details
-
Builder
public Builder()Deprecated.
-
-
Method Details
-
version
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getVersion()
- Parameters:
version
- The Elasticsearch version that your domain will leverage. This parameter is required.- Returns:
this
-
accessPolicies
@Stability(Deprecated) @Deprecated public DomainProps.Builder accessPolicies(List<? extends PolicyStatement> accessPolicies) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getAccessPolicies()
- Parameters:
accessPolicies
- Domain Access policies.- Returns:
this
-
advancedOptions
@Stability(Deprecated) @Deprecated public DomainProps.Builder advancedOptions(Map<String, String> advancedOptions) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getAdvancedOptions()
- Parameters:
advancedOptions
- Additional options to specify for the Amazon ES domain.- Returns:
this
-
automatedSnapshotStartHour
@Stability(Deprecated) @Deprecated public DomainProps.Builder automatedSnapshotStartHour(Number automatedSnapshotStartHour) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getAutomatedSnapshotStartHour()
- Parameters:
automatedSnapshotStartHour
- 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.- Returns:
this
-
capacity
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getCapacity()
- Parameters:
capacity
- The cluster capacity configuration for the Amazon ES domain.- Returns:
this
-
cognitoKibanaAuth
@Stability(Deprecated) @Deprecated public DomainProps.Builder cognitoKibanaAuth(CognitoOptions cognitoKibanaAuth) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getCognitoKibanaAuth()
- Parameters:
cognitoKibanaAuth
- Configures Amazon ES to use Amazon Cognito authentication for Kibana.- Returns:
this
-
customEndpoint
@Stability(Deprecated) @Deprecated public DomainProps.Builder customEndpoint(CustomEndpointOptions customEndpoint) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getCustomEndpoint()
- Parameters:
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- Returns:
this
-
domainName
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getDomainName()
- Parameters:
domainName
- Enforces a particular physical domain name.- Returns:
this
-
ebs
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getEbs()
- Parameters:
ebs
- 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.- Returns:
this
-
enableVersionUpgrade
@Stability(Deprecated) @Deprecated public DomainProps.Builder enableVersionUpgrade(Boolean enableVersionUpgrade) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getEnableVersionUpgrade()
- 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.- Returns:
this
-
encryptionAtRest
@Stability(Deprecated) @Deprecated public DomainProps.Builder encryptionAtRest(EncryptionAtRestOptions encryptionAtRest) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getEncryptionAtRest()
- Parameters:
encryptionAtRest
- Encryption at rest options for the cluster.- Returns:
this
-
enforceHttps
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getEnforceHttps()
- Parameters:
enforceHttps
- True to require that all traffic to the domain arrive over HTTPS.- Returns:
this
-
fineGrainedAccessControl
@Stability(Deprecated) @Deprecated public DomainProps.Builder fineGrainedAccessControl(AdvancedSecurityOptions fineGrainedAccessControl) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getFineGrainedAccessControl()
- Parameters:
fineGrainedAccessControl
- 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.- Returns:
this
-
logging
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getLogging()
- Parameters:
logging
- Configuration log publishing configuration options.- Returns:
this
-
nodeToNodeEncryption
@Stability(Deprecated) @Deprecated public DomainProps.Builder nodeToNodeEncryption(Boolean nodeToNodeEncryption) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getNodeToNodeEncryption()
- Parameters:
nodeToNodeEncryption
- Specify true to enable node to node encryption. Requires Elasticsearch version 6.0 or later.- Returns:
this
-
removalPolicy
@Stability(Deprecated) @Deprecated public DomainProps.Builder removalPolicy(RemovalPolicy removalPolicy) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getRemovalPolicy()
- Parameters:
removalPolicy
- Policy to apply when the domain is removed from the stack.- Returns:
this
-
securityGroups
@Stability(Deprecated) @Deprecated public DomainProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getSecurityGroups()
- Parameters:
securityGroups
- The list of security groups that are associated with the VPC endpoints for the domain. Only used ifvpc
is specified.- Returns:
this
-
tlsSecurityPolicy
@Stability(Deprecated) @Deprecated public DomainProps.Builder tlsSecurityPolicy(TLSSecurityPolicy tlsSecurityPolicy) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getTlsSecurityPolicy()
- Parameters:
tlsSecurityPolicy
- The minimum TLS version required for traffic to the domain.- Returns:
this
-
useUnsignedBasicAuth
@Stability(Deprecated) @Deprecated public DomainProps.Builder useUnsignedBasicAuth(Boolean useUnsignedBasicAuth) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getUseUnsignedBasicAuth()
- Parameters:
useUnsignedBasicAuth
- Configures the domain so that unsigned basic auth is enabled. If no master user is provided a default master user with usernameadmin
and a dynamically generated password stored in KMS is created. The password can be retrieved by gettingmasterUserPassword
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.
- Returns:
this
-
vpc
Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getVpc()
- Parameters:
vpc
- Place the domain inside this VPC.- Returns:
this
-
vpcSubnets
@Stability(Deprecated) @Deprecated public DomainProps.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getVpcSubnets()
- Parameters:
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.- Returns:
this
-
zoneAwareness
@Stability(Deprecated) @Deprecated public DomainProps.Builder zoneAwareness(ZoneAwarenessConfig zoneAwareness) Deprecated.use opensearchservice module insteadSets the value ofDomainProps.getZoneAwareness()
- Parameters:
zoneAwareness
- The cluster zone awareness configuration for the Amazon ES domain.- Returns:
this
-
build
Deprecated.Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DomainProps>
- Returns:
- a new instance of
DomainProps
- Throws:
NullPointerException
- if any required attribute was not provided
-