Interface DomainStatus.Builder

    • Method Detail

      • 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. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        Parameters:
        endpoints - The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
        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.
      • 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.
      • 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, IPAddressType
      • 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:
        IPAddressType, IPAddressType
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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:
        DomainProcessingStatusType, DomainProcessingStatusType
      • 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.