Package software.amazon.awssdk.services.elasticsearch.model

Class CreateElasticsearchDomainRequest

    • Method Detail

      • domainName

        public final String domainName()

        The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        Returns:
        The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • elasticsearchVersion

        public final String elasticsearchVersion()

        String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

        Returns:
        String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

      • elasticsearchClusterConfig

        public final ElasticsearchClusterConfig elasticsearchClusterConfig()

        Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

        Returns:
        Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

      • ebsOptions

        public final EBSOptions ebsOptions()

        Options to enable, disable and specify the type and size of EBS storage volumes.

        Returns:
        Options to enable, disable and specify the type and size of EBS storage volumes.

      • accessPolicies

        public final String accessPolicies()

        IAM access policy as a JSON-formatted string.

        Returns:
        IAM access policy as a JSON-formatted string.

      • snapshotOptions

        public final SnapshotOptions snapshotOptions()

        Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

        Returns:
        Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

      • vpcOptions

        public final VPCOptions vpcOptions()

        Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

        Returns:
        Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

      • encryptionAtRestOptions

        public final EncryptionAtRestOptions encryptionAtRestOptions()

        Specifies the Encryption At Rest Options.

        Returns:
        Specifies the Encryption At Rest Options.

      • nodeToNodeEncryptionOptions

        public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()

        Specifies the NodeToNodeEncryptionOptions.

        Returns:
        Specifies the NodeToNodeEncryptionOptions.

      • hasAdvancedOptions

        public final boolean hasAdvancedOptions()
        For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • advancedOptions

        public final Map<String,​String> advancedOptions()

        Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.

        Returns:
        Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

      • logPublishingOptions

        public final Map<LogType,​LogPublishingOption> logPublishingOptions()

        Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.

        Returns:
        Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

      • hasLogPublishingOptions

        public final boolean hasLogPublishingOptions()
        For responses, this returns true if the service returned a value for the LogPublishingOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • logPublishingOptionsAsStrings

        public final Map<String,​LogPublishingOption> logPublishingOptionsAsStrings()

        Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.

        Returns:
        Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

      • domainEndpointOptions

        public final DomainEndpointOptions domainEndpointOptions()

        Options to specify configuration that will be applied to the domain endpoint.

        Returns:
        Options to specify configuration that will be applied to the domain endpoint.

      • advancedSecurityOptions

        public final AdvancedSecurityOptionsInput advancedSecurityOptions()

        Specifies advanced security options.

        Returns:
        Specifies advanced security options.

      • autoTuneOptions

        public final AutoTuneOptionsInput autoTuneOptions()

        Specifies Auto-Tune options.

        Returns:
        Specifies Auto-Tune options.

      • hasTagList

        public final boolean hasTagList()
        For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tagList

        public final List<Tag> tagList()

        A list of Tag added during domain creation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.

        Returns:
        A list of Tag added during domain creation.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object