Package software.amazon.awssdk.services.opensearch.model

Interface DomainStatus.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DomainStatus.Builder,DomainStatus>, SdkBuilder<DomainStatus.Builder,DomainStatus>, SdkPojo
Enclosing class:
DomainStatus
public static interface DomainStatus.Builder extends SdkPojo, CopyableBuilder<DomainStatus.Builder,DomainStatus>

  • Method Details

    • domainId

      DomainStatus.Builder domainId(String domainId)

      Unique identifier for the domain.

      Parameters:
      domainId - Unique identifier for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainName

      DomainStatus.Builder domainName(String domainName)

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

      Parameters:
      domainName - Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      DomainStatus.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • created

      DomainStatus.Builder created(Boolean created)

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

      Parameters:
      created - Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleted

      DomainStatus.Builder deleted(Boolean deleted)

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

      Parameters:
      deleted - Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      DomainStatus.Builder endpoint(String endpoint)

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

      Parameters:
      endpoint - Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointV2

      DomainStatus.Builder endpointV2(String endpointV2)

      If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

      Parameters:
      endpointV2 - If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      DomainStatus.Builder endpoints(Map<String,String> endpoints)

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

      • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

      • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

      Parameters:
      endpoints - The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

      • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

      • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainEndpointV2HostedZoneId

      DomainStatus.Builder domainEndpointV2HostedZoneId(String domainEndpointV2HostedZoneId)

      The dual stack hosted zone ID for the domain.

      Parameters:
      domainEndpointV2HostedZoneId - The dual stack hosted zone ID for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processing

      DomainStatus.Builder processing(Boolean processing)

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

      Parameters:
      processing - The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upgradeProcessing

      DomainStatus.Builder upgradeProcessing(Boolean upgradeProcessing)

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

      Parameters:
      upgradeProcessing - The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      DomainStatus.Builder engineVersion(String engineVersion)

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

      Parameters:
      engineVersion - Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterConfig

      DomainStatus.Builder clusterConfig(ClusterConfig clusterConfig)

      Container for the cluster configuration of the domain.

      Parameters:
      clusterConfig - Container for the cluster configuration of the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterConfig

      default DomainStatus.Builder clusterConfig(Consumer<ClusterConfig.Builder> clusterConfig)

      Container for the cluster configuration of the domain.

      This is a convenience method that creates an instance of the ClusterConfig.Builder avoiding the need to create one manually via ClusterConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterConfig(ClusterConfig).

      Parameters:
      clusterConfig - a consumer that will call methods on ClusterConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ebsOptions

      DomainStatus.Builder ebsOptions(EBSOptions ebsOptions)

      Container for EBS-based storage settings for the domain.

      Parameters:
      ebsOptions - Container for EBS-based storage settings for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ebsOptions

      default DomainStatus.Builder ebsOptions(Consumer<EBSOptions.Builder> ebsOptions)

      Container for EBS-based storage settings for the domain.

      This is a convenience method that creates an instance of the EBSOptions.Builder avoiding the need to create one manually via EBSOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ebsOptions(EBSOptions).

      Parameters:
      ebsOptions - a consumer that will call methods on EBSOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessPolicies

      DomainStatus.Builder accessPolicies(String accessPolicies)

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

      Parameters:
      accessPolicies - Identity and Access Management (IAM) policy document specifying the access policies for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      DomainStatus.Builder ipAddressType(String ipAddressType)

      The type of IP addresses supported by the endpoint for the domain.

      Parameters:
      ipAddressType - The type of IP addresses supported by the endpoint for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAddressType

      DomainStatus.Builder ipAddressType(IPAddressType ipAddressType)

      The type of IP addresses supported by the endpoint for the domain.

      Parameters:
      ipAddressType - The type of IP addresses supported by the endpoint for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snapshotOptions

      DomainStatus.Builder snapshotOptions(SnapshotOptions 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 DomainStatus.Builder snapshotOptions(Consumer<SnapshotOptions.Builder> snapshotOptions)

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      This is a convenience method that creates an instance of the SnapshotOptions.Builder avoiding the need to create one manually via SnapshotOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snapshotOptions(SnapshotOptions).

      Parameters:
      snapshotOptions - a consumer that will call methods on SnapshotOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcOptions

      DomainStatus.Builder vpcOptions(VPCDerivedInfo vpcOptions)

      The VPC configuration for the domain.

      Parameters:
      vpcOptions - The VPC configuration for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcOptions

      default DomainStatus.Builder vpcOptions(Consumer<VPCDerivedInfo.Builder> vpcOptions)

      The VPC configuration for the domain.

      This is a convenience method that creates an instance of the VPCDerivedInfo.Builder avoiding the need to create one manually via VPCDerivedInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcOptions(VPCDerivedInfo).

      Parameters:
      vpcOptions - a consumer that will call methods on VPCDerivedInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cognitoOptions

      DomainStatus.Builder cognitoOptions(CognitoOptions cognitoOptions)

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      Parameters:
      cognitoOptions - Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cognitoOptions

      default DomainStatus.Builder cognitoOptions(Consumer<CognitoOptions.Builder> cognitoOptions)

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      This is a convenience method that creates an instance of the CognitoOptions.Builder avoiding the need to create one manually via CognitoOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cognitoOptions(CognitoOptions).

      Parameters:
      cognitoOptions - a consumer that will call methods on CognitoOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionAtRestOptions

      DomainStatus.Builder encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

      Encryption at rest settings for the domain.

      Parameters:
      encryptionAtRestOptions - Encryption at rest settings for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionAtRestOptions

      default DomainStatus.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)

      Encryption at rest settings for the domain.

      This is a convenience method that creates an instance of the EncryptionAtRestOptions.Builder avoiding the need to create one manually via EncryptionAtRestOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionAtRestOptions(EncryptionAtRestOptions).

      Parameters:
      encryptionAtRestOptions - a consumer that will call methods on EncryptionAtRestOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeToNodeEncryptionOptions

      DomainStatus.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions 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 DomainStatus.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions)

      Whether node-to-node encryption is enabled or disabled.

      This is a convenience method that creates an instance of the NodeToNodeEncryptionOptions.Builder avoiding the need to create one manually via NodeToNodeEncryptionOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions).

      Parameters:
      nodeToNodeEncryptionOptions - a consumer that will call methods on NodeToNodeEncryptionOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • advancedOptions

      DomainStatus.Builder advancedOptions(Map<String,String> advancedOptions)

      Key-value pairs that specify advanced configuration options.

      Parameters:
      advancedOptions - Key-value pairs that specify advanced configuration options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptionsWithStrings

      DomainStatus.Builder logPublishingOptionsWithStrings(Map<String,LogPublishingOption> logPublishingOptions)

      Log publishing options for the domain.

      Parameters:
      logPublishingOptions - Log publishing options for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptions

      DomainStatus.Builder logPublishingOptions(Map<LogType,LogPublishingOption> logPublishingOptions)

      Log publishing options for the domain.

      Parameters:
      logPublishingOptions - Log publishing options for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceSoftwareOptions

      DomainStatus.Builder serviceSoftwareOptions(ServiceSoftwareOptions serviceSoftwareOptions)

      The current status of the domain's service software.

      Parameters:
      serviceSoftwareOptions - The current status of the domain's service software.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceSoftwareOptions

      default DomainStatus.Builder serviceSoftwareOptions(Consumer<ServiceSoftwareOptions.Builder> serviceSoftwareOptions)

      The current status of the domain's service software.

      This is a convenience method that creates an instance of the ServiceSoftwareOptions.Builder avoiding the need to create one manually via ServiceSoftwareOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceSoftwareOptions(ServiceSoftwareOptions).

      Parameters:
      serviceSoftwareOptions - a consumer that will call methods on ServiceSoftwareOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainEndpointOptions

      DomainStatus.Builder domainEndpointOptions(DomainEndpointOptions 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 DomainStatus.Builder domainEndpointOptions(Consumer<DomainEndpointOptions.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 the DomainEndpointOptions.Builder avoiding the need to create one manually via DomainEndpointOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainEndpointOptions(DomainEndpointOptions).

      Parameters:
      domainEndpointOptions - a consumer that will call methods on DomainEndpointOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • advancedSecurityOptions

      DomainStatus.Builder advancedSecurityOptions(AdvancedSecurityOptions advancedSecurityOptions)

      Settings for fine-grained access control.

      Parameters:
      advancedSecurityOptions - Settings for fine-grained access control.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • advancedSecurityOptions

      default DomainStatus.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptions.Builder> advancedSecurityOptions)

      Settings for fine-grained access control.

      This is a convenience method that creates an instance of the AdvancedSecurityOptions.Builder avoiding the need to create one manually via AdvancedSecurityOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to advancedSecurityOptions(AdvancedSecurityOptions).

      Parameters:
      advancedSecurityOptions - a consumer that will call methods on AdvancedSecurityOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoTuneOptions

      DomainStatus.Builder autoTuneOptions(AutoTuneOptionsOutput autoTuneOptions)

      Auto-Tune settings for the domain.

      Parameters:
      autoTuneOptions - Auto-Tune settings for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoTuneOptions

      default DomainStatus.Builder autoTuneOptions(Consumer<AutoTuneOptionsOutput.Builder> autoTuneOptions)

      Auto-Tune settings for the domain.

      This is a convenience method that creates an instance of the AutoTuneOptionsOutput.Builder avoiding the need to create one manually via AutoTuneOptionsOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoTuneOptions(AutoTuneOptionsOutput).

      Parameters:
      autoTuneOptions - a consumer that will call methods on AutoTuneOptionsOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • changeProgressDetails

      DomainStatus.Builder changeProgressDetails(ChangeProgressDetails changeProgressDetails)

      Information about a configuration change happening on the domain.

      Parameters:
      changeProgressDetails - Information about a configuration change happening on the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeProgressDetails

      default DomainStatus.Builder changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails)

      Information about a configuration change happening on the domain.

      This is a convenience method that creates an instance of the ChangeProgressDetails.Builder avoiding the need to create one manually via ChangeProgressDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to changeProgressDetails(ChangeProgressDetails).

      Parameters:
      changeProgressDetails - a consumer that will call methods on ChangeProgressDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offPeakWindowOptions

      DomainStatus.Builder offPeakWindowOptions(OffPeakWindowOptions offPeakWindowOptions)

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      Parameters:
      offPeakWindowOptions - Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • offPeakWindowOptions

      default DomainStatus.Builder offPeakWindowOptions(Consumer<OffPeakWindowOptions.Builder> offPeakWindowOptions)

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      This is a convenience method that creates an instance of the OffPeakWindowOptions.Builder avoiding the need to create one manually via OffPeakWindowOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offPeakWindowOptions(OffPeakWindowOptions).

      Parameters:
      offPeakWindowOptions - a consumer that will call methods on OffPeakWindowOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • softwareUpdateOptions

      DomainStatus.Builder softwareUpdateOptions(SoftwareUpdateOptions softwareUpdateOptions)

      Service software update options for the domain.

      Parameters:
      softwareUpdateOptions - Service software update options for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • softwareUpdateOptions

      default DomainStatus.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions)

      Service software update options for the domain.

      This is a convenience method that creates an instance of the SoftwareUpdateOptions.Builder avoiding the need to create one manually via SoftwareUpdateOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to softwareUpdateOptions(SoftwareUpdateOptions).

      Parameters:
      softwareUpdateOptions - a consumer that will call methods on SoftwareUpdateOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainProcessingStatus

      DomainStatus.Builder domainProcessingStatus(String domainProcessingStatus)

      The status of any changes that are currently in progress for the domain.

      Parameters:
      domainProcessingStatus - The status of any changes that are currently in progress for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainProcessingStatus

      DomainStatus.Builder domainProcessingStatus(DomainProcessingStatusType domainProcessingStatus)

      The status of any changes that are currently in progress for the domain.

      Parameters:
      domainProcessingStatus - The status of any changes that are currently in progress for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modifyingProperties

      DomainStatus.Builder modifyingProperties(Collection<ModifyingProperties> 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

      DomainStatus.Builder modifyingProperties(ModifyingProperties... 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

      DomainStatus.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 the ModifyingProperties.Builder avoiding the need to create one manually via ModifyingProperties.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modifyingProperties(List<ModifyingProperties>).

      Parameters:
      modifyingProperties - a consumer that will call methods on ModifyingProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: