Interface DomainConfig.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DomainConfig.Builder,
,DomainConfig> SdkBuilder<DomainConfig.Builder,
,DomainConfig> SdkPojo
- Enclosing class:
DomainConfig
-
Method Summary
Modifier and TypeMethodDescriptiondefault DomainConfig.Builder
accessPolicies
(Consumer<AccessPoliciesStatus.Builder> accessPolicies) Specifies the access policies for the domain.accessPolicies
(AccessPoliciesStatus accessPolicies) Specifies the access policies for the domain.default DomainConfig.Builder
advancedOptions
(Consumer<AdvancedOptionsStatus.Builder> advancedOptions) Key-value pairs to specify advanced configuration options.advancedOptions
(AdvancedOptionsStatus advancedOptions) Key-value pairs to specify advanced configuration options.default DomainConfig.Builder
advancedSecurityOptions
(Consumer<AdvancedSecurityOptionsStatus.Builder> advancedSecurityOptions) Container for fine-grained access control settings for the domain.advancedSecurityOptions
(AdvancedSecurityOptionsStatus advancedSecurityOptions) Container for fine-grained access control settings for the domain.default DomainConfig.Builder
autoTuneOptions
(Consumer<AutoTuneOptionsStatus.Builder> autoTuneOptions) Container for Auto-Tune settings for the domain.autoTuneOptions
(AutoTuneOptionsStatus autoTuneOptions) Container for Auto-Tune settings for the domain.default DomainConfig.Builder
changeProgressDetails
(Consumer<ChangeProgressDetails.Builder> changeProgressDetails) Container for information about the progress of an existing configuration change.changeProgressDetails
(ChangeProgressDetails changeProgressDetails) Container for information about the progress of an existing configuration change.default DomainConfig.Builder
clusterConfig
(Consumer<ClusterConfigStatus.Builder> clusterConfig) Container for the cluster configuration of a the domain.clusterConfig
(ClusterConfigStatus clusterConfig) Container for the cluster configuration of a the domain.default DomainConfig.Builder
cognitoOptions
(Consumer<CognitoOptionsStatus.Builder> cognitoOptions) Container for Amazon Cognito options for the domain.cognitoOptions
(CognitoOptionsStatus cognitoOptions) Container for Amazon Cognito options for the domain.default DomainConfig.Builder
domainEndpointOptions
(Consumer<DomainEndpointOptionsStatus.Builder> domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.domainEndpointOptions
(DomainEndpointOptionsStatus domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.default DomainConfig.Builder
ebsOptions
(Consumer<EBSOptionsStatus.Builder> ebsOptions) Container for EBS options configured for the domain.ebsOptions
(EBSOptionsStatus ebsOptions) Container for EBS options configured for the domain.default DomainConfig.Builder
encryptionAtRestOptions
(Consumer<EncryptionAtRestOptionsStatus.Builder> encryptionAtRestOptions) Key-value pairs to enable encryption at rest.encryptionAtRestOptions
(EncryptionAtRestOptionsStatus encryptionAtRestOptions) Key-value pairs to enable encryption at rest.default DomainConfig.Builder
engineVersion
(Consumer<VersionStatus.Builder> engineVersion) The OpenSearch or Elasticsearch version that the domain is running.engineVersion
(VersionStatus engineVersion) The OpenSearch or Elasticsearch version that the domain is running.default DomainConfig.Builder
ipAddressType
(Consumer<IPAddressTypeStatus.Builder> ipAddressType) Choose either dual stack or IPv4 as your IP address type.ipAddressType
(IPAddressTypeStatus ipAddressType) Choose either dual stack or IPv4 as your IP address type.default DomainConfig.Builder
logPublishingOptions
(Consumer<LogPublishingOptionsStatus.Builder> logPublishingOptions) Key-value pairs to configure log publishing.logPublishingOptions
(LogPublishingOptionsStatus logPublishingOptions) Key-value pairs to configure log publishing.modifyingProperties
(Collection<ModifyingProperties> modifyingProperties) Information about the domain properties that are currently being modified.modifyingProperties
(Consumer<ModifyingProperties.Builder>... modifyingProperties) Information about the domain properties that are currently being modified.modifyingProperties
(ModifyingProperties... modifyingProperties) Information about the domain properties that are currently being modified.default DomainConfig.Builder
nodeToNodeEncryptionOptions
(Consumer<NodeToNodeEncryptionOptionsStatus.Builder> nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.nodeToNodeEncryptionOptions
(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.default DomainConfig.Builder
offPeakWindowOptions
(Consumer<OffPeakWindowOptionsStatus.Builder> offPeakWindowOptions) Container for off-peak window options for the domain.offPeakWindowOptions
(OffPeakWindowOptionsStatus offPeakWindowOptions) Container for off-peak window options for the domain.default DomainConfig.Builder
snapshotOptions
(Consumer<SnapshotOptionsStatus.Builder> snapshotOptions) DEPRECATED.snapshotOptions
(SnapshotOptionsStatus snapshotOptions) DEPRECATED.default DomainConfig.Builder
softwareUpdateOptions
(Consumer<SoftwareUpdateOptionsStatus.Builder> softwareUpdateOptions) Software update options for the domain.softwareUpdateOptions
(SoftwareUpdateOptionsStatus softwareUpdateOptions) Software update options for the domain.default DomainConfig.Builder
vpcOptions
(Consumer<VPCDerivedInfoStatus.Builder> vpcOptions) The current VPC options for the domain and the status of any updates to their configuration.vpcOptions
(VPCDerivedInfoStatus vpcOptions) The current VPC options for the domain and the status of any updates to their configuration.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
engineVersion
The OpenSearch or Elasticsearch version that the domain is running.
- Parameters:
engineVersion
- The OpenSearch or Elasticsearch version that the domain is running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The OpenSearch or Elasticsearch version that the domain is running.
This is a convenience method that creates an instance of theVersionStatus.Builder
avoiding the need to create one manually viaVersionStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toengineVersion(VersionStatus)
.- Parameters:
engineVersion
- a consumer that will call methods onVersionStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clusterConfig
Container for the cluster configuration of a the domain.
- Parameters:
clusterConfig
- Container for the cluster configuration of a the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterConfig
Container for the cluster configuration of a the domain.
This is a convenience method that creates an instance of theClusterConfigStatus.Builder
avoiding the need to create one manually viaClusterConfigStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterConfig(ClusterConfigStatus)
.- Parameters:
clusterConfig
- a consumer that will call methods onClusterConfigStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ebsOptions
Container for EBS options configured for the domain.
- Parameters:
ebsOptions
- Container for EBS options configured for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ebsOptions
Container for EBS options configured for the domain.
This is a convenience method that creates an instance of theEBSOptionsStatus.Builder
avoiding the need to create one manually viaEBSOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toebsOptions(EBSOptionsStatus)
.- Parameters:
ebsOptions
- a consumer that will call methods onEBSOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
accessPolicies
Specifies the access policies for the domain.
- Parameters:
accessPolicies
- Specifies the access policies for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessPolicies
Specifies the access policies for the domain.
This is a convenience method that creates an instance of theAccessPoliciesStatus.Builder
avoiding the need to create one manually viaAccessPoliciesStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessPolicies(AccessPoliciesStatus)
.- Parameters:
accessPolicies
- a consumer that will call methods onAccessPoliciesStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipAddressType
Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
- Parameters:
ipAddressType
- Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddressType
Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
This is a convenience method that creates an instance of theIPAddressTypeStatus.Builder
avoiding the need to create one manually viaIPAddressTypeStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toipAddressType(IPAddressTypeStatus)
.- Parameters:
ipAddressType
- a consumer that will call methods onIPAddressTypeStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
snapshotOptions
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
- Parameters:
snapshotOptions
- DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotOptions
default DomainConfig.Builder snapshotOptions(Consumer<SnapshotOptionsStatus.Builder> snapshotOptions) DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
This is a convenience method that creates an instance of theSnapshotOptionsStatus.Builder
avoiding the need to create one manually viaSnapshotOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosnapshotOptions(SnapshotOptionsStatus)
.- Parameters:
snapshotOptions
- a consumer that will call methods onSnapshotOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcOptions
The current VPC options for the domain and the status of any updates to their configuration.
- Parameters:
vpcOptions
- The current VPC options for the domain and the status of any updates to their configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcOptions
The current VPC options for the domain and the status of any updates to their configuration.
This is a convenience method that creates an instance of theVPCDerivedInfoStatus.Builder
avoiding the need to create one manually viaVPCDerivedInfoStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcOptions(VPCDerivedInfoStatus)
.- Parameters:
vpcOptions
- a consumer that will call methods onVPCDerivedInfoStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cognitoOptions
Container for Amazon Cognito options for the domain.
- Parameters:
cognitoOptions
- Container for Amazon Cognito options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cognitoOptions
Container for Amazon Cognito options for the domain.
This is a convenience method that creates an instance of theCognitoOptionsStatus.Builder
avoiding the need to create one manually viaCognitoOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocognitoOptions(CognitoOptionsStatus)
.- Parameters:
cognitoOptions
- a consumer that will call methods onCognitoOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionAtRestOptions
Key-value pairs to enable encryption at rest.
- Parameters:
encryptionAtRestOptions
- Key-value pairs to enable encryption at rest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionAtRestOptions
default DomainConfig.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptionsStatus.Builder> encryptionAtRestOptions) Key-value pairs to enable encryption at rest.
This is a convenience method that creates an instance of theEncryptionAtRestOptionsStatus.Builder
avoiding the need to create one manually viaEncryptionAtRestOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionAtRestOptions(EncryptionAtRestOptionsStatus)
.- Parameters:
encryptionAtRestOptions
- a consumer that will call methods onEncryptionAtRestOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nodeToNodeEncryptionOptions
DomainConfig.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.
- Parameters:
nodeToNodeEncryptionOptions
- Whether node-to-node encryption is enabled or disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeToNodeEncryptionOptions
default DomainConfig.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptionsStatus.Builder> nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.
This is a convenience method that creates an instance of theNodeToNodeEncryptionOptionsStatus.Builder
avoiding the need to create one manually viaNodeToNodeEncryptionOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus)
.- Parameters:
nodeToNodeEncryptionOptions
- a consumer that will call methods onNodeToNodeEncryptionOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
advancedOptions
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
- Parameters:
advancedOptions
- Key-value pairs to specify advanced configuration options. For more information, see Advanced options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
advancedOptions
default DomainConfig.Builder advancedOptions(Consumer<AdvancedOptionsStatus.Builder> advancedOptions) Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
This is a convenience method that creates an instance of theAdvancedOptionsStatus.Builder
avoiding the need to create one manually viaAdvancedOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadvancedOptions(AdvancedOptionsStatus)
.- Parameters:
advancedOptions
- a consumer that will call methods onAdvancedOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logPublishingOptions
Key-value pairs to configure log publishing.
- Parameters:
logPublishingOptions
- Key-value pairs to configure log publishing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logPublishingOptions
default DomainConfig.Builder logPublishingOptions(Consumer<LogPublishingOptionsStatus.Builder> logPublishingOptions) Key-value pairs to configure log publishing.
This is a convenience method that creates an instance of theLogPublishingOptionsStatus.Builder
avoiding the need to create one manually viaLogPublishingOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologPublishingOptions(LogPublishingOptionsStatus)
.- Parameters:
logPublishingOptions
- a consumer that will call methods onLogPublishingOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
- Parameters:
domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainEndpointOptions
default DomainConfig.Builder domainEndpointOptions(Consumer<DomainEndpointOptionsStatus.Builder> domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
This is a convenience method that creates an instance of theDomainEndpointOptionsStatus.Builder
avoiding the need to create one manually viaDomainEndpointOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todomainEndpointOptions(DomainEndpointOptionsStatus)
.- Parameters:
domainEndpointOptions
- a consumer that will call methods onDomainEndpointOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
advancedSecurityOptions
Container for fine-grained access control settings for the domain.
- Parameters:
advancedSecurityOptions
- Container for fine-grained access control settings for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
advancedSecurityOptions
default DomainConfig.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptionsStatus.Builder> advancedSecurityOptions) Container for fine-grained access control settings for the domain.
This is a convenience method that creates an instance of theAdvancedSecurityOptionsStatus.Builder
avoiding the need to create one manually viaAdvancedSecurityOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadvancedSecurityOptions(AdvancedSecurityOptionsStatus)
.- Parameters:
advancedSecurityOptions
- a consumer that will call methods onAdvancedSecurityOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autoTuneOptions
Container for Auto-Tune settings for the domain.
- Parameters:
autoTuneOptions
- Container for Auto-Tune settings for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoTuneOptions
default DomainConfig.Builder autoTuneOptions(Consumer<AutoTuneOptionsStatus.Builder> autoTuneOptions) Container for Auto-Tune settings for the domain.
This is a convenience method that creates an instance of theAutoTuneOptionsStatus.Builder
avoiding the need to create one manually viaAutoTuneOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoTuneOptions(AutoTuneOptionsStatus)
.- Parameters:
autoTuneOptions
- a consumer that will call methods onAutoTuneOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
changeProgressDetails
Container for information about the progress of an existing configuration change.
- Parameters:
changeProgressDetails
- Container for information about the progress of an existing configuration change.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
changeProgressDetails
default DomainConfig.Builder changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails) Container for information about the progress of an existing configuration change.
This is a convenience method that creates an instance of theChangeProgressDetails.Builder
avoiding the need to create one manually viaChangeProgressDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochangeProgressDetails(ChangeProgressDetails)
.- Parameters:
changeProgressDetails
- a consumer that will call methods onChangeProgressDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
offPeakWindowOptions
Container for off-peak window options for the domain.
- Parameters:
offPeakWindowOptions
- Container for off-peak window options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
offPeakWindowOptions
default DomainConfig.Builder offPeakWindowOptions(Consumer<OffPeakWindowOptionsStatus.Builder> offPeakWindowOptions) Container for off-peak window options for the domain.
This is a convenience method that creates an instance of theOffPeakWindowOptionsStatus.Builder
avoiding the need to create one manually viaOffPeakWindowOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooffPeakWindowOptions(OffPeakWindowOptionsStatus)
.- Parameters:
offPeakWindowOptions
- a consumer that will call methods onOffPeakWindowOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
softwareUpdateOptions
Software update options for the domain.
- Parameters:
softwareUpdateOptions
- Software update options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
softwareUpdateOptions
default DomainConfig.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptionsStatus.Builder> softwareUpdateOptions) Software update options for the domain.
This is a convenience method that creates an instance of theSoftwareUpdateOptionsStatus.Builder
avoiding the need to create one manually viaSoftwareUpdateOptionsStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosoftwareUpdateOptions(SoftwareUpdateOptionsStatus)
.- Parameters:
softwareUpdateOptions
- a consumer that will call methods onSoftwareUpdateOptionsStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
modifyingProperties
Information about the domain properties that are currently being modified.
- Parameters:
modifyingProperties
- Information about the domain properties that are currently being modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modifyingProperties
Information about the domain properties that are currently being modified.
- Parameters:
modifyingProperties
- Information about the domain properties that are currently being modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modifyingProperties
DomainConfig.Builder modifyingProperties(Consumer<ModifyingProperties.Builder>... modifyingProperties) Information about the domain properties that are currently being modified.
This is a convenience method that creates an instance of theModifyingProperties.Builder
avoiding the need to create one manually viaModifyingProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomodifyingProperties(List<ModifyingProperties>)
.- Parameters:
modifyingProperties
- a consumer that will call methods onModifyingProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-