Struct aws_sdk_opensearch::client::fluent_builders::CreateDomain

pub struct CreateDomain { /* private fields */ }

Fluent builder constructing a request to CreateDomain.

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Implementations

impl CreateDomain

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateDomain, AwsResponseRetryClassifier>, SdkError<CreateDomainError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateDomainOutput, SdkError<CreateDomainError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn domain_name(self, input: impl Into<String>) -> Self

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

pub fn set_domain_name(self, input: Option<String>) -> Self

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

pub fn engine_version(self, input: impl Into<String>) -> Self

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

pub fn set_engine_version(self, input: Option<String>) -> Self

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

pub fn cluster_config(self, input: ClusterConfig) -> Self

Container for the cluster configuration of a domain.

pub fn set_cluster_config(self, input: Option<ClusterConfig>) -> Self

Container for the cluster configuration of a domain.

pub fn ebs_options(self, input: EbsOptions) -> Self

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

pub fn set_ebs_options(self, input: Option<EbsOptions>) -> Self

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

pub fn access_policies(self, input: impl Into<String>) -> Self

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

pub fn set_access_policies(self, input: Option<String>) -> Self

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

pub fn snapshot_options(self, input: SnapshotOptions) -> Self

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

pub fn set_snapshot_options(self, input: Option<SnapshotOptions>) -> Self

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

pub fn vpc_options(self, input: VpcOptions) -> Self

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

pub fn set_vpc_options(self, input: Option<VpcOptions>) -> Self

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

pub fn cognito_options(self, input: CognitoOptions) -> Self

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

pub fn set_cognito_options(self, input: Option<CognitoOptions>) -> Self

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self

Key-value pairs to enable encryption at rest.

pub fn set_encryption_at_rest_options(
    self,
    input: Option<EncryptionAtRestOptions>
) -> Self

Key-value pairs to enable encryption at rest.

pub fn node_to_node_encryption_options(
    self,
    input: NodeToNodeEncryptionOptions
) -> Self

Enables node-to-node encryption.

pub fn set_node_to_node_encryption_options(
    self,
    input: Option<NodeToNodeEncryptionOptions>
) -> Self

Enables node-to-node encryption.

pub fn advanced_options(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to AdvancedOptions.

To override the contents of this collection use set_advanced_options.

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

pub fn set_advanced_options(self, input: Option<HashMap<String, String>>) -> Self

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

pub fn log_publishing_options(self, k: LogType, v: LogPublishingOption) -> Self

Adds a key-value pair to LogPublishingOptions.

To override the contents of this collection use set_log_publishing_options.

Key-value pairs to configure slow log publishing.

pub fn set_log_publishing_options(
    self,
    input: Option<HashMap<LogType, LogPublishingOption>>
) -> Self

Key-value pairs to configure slow log publishing.

pub fn domain_endpoint_options(self, input: DomainEndpointOptions) -> Self

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

pub fn set_domain_endpoint_options(
    self,
    input: Option<DomainEndpointOptions>
) -> Self

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

pub fn advanced_security_options(
    self,
    input: AdvancedSecurityOptionsInput
) -> Self

Options for fine-grained access control.

pub fn set_advanced_security_options(
    self,
    input: Option<AdvancedSecurityOptionsInput>
) -> Self

Options for fine-grained access control.

pub fn tag_list(self, input: Tag) -> Self

Appends an item to TagList.

To override the contents of this collection use set_tag_list.

List of tags to add to the domain upon creation.

pub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self

List of tags to add to the domain upon creation.

pub fn auto_tune_options(self, input: AutoTuneOptionsInput) -> Self

Options for Auto-Tune.

pub fn set_auto_tune_options(self, input: Option<AutoTuneOptionsInput>) -> Self

Options for Auto-Tune.

Trait Implementations

impl Clone for CreateDomain

fn clone(&self) -> CreateDomain

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDomain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.