Struct aws_sdk_opensearch::operation::create_domain::CreateDomainInput

#[non_exhaustive]
pub struct CreateDomainInput {

    pub domain_name: Option<String>,
    pub engine_version: Option<String>,
    pub cluster_config: Option<ClusterConfig>,
    pub ebs_options: Option<EbsOptions>,
    pub access_policies: Option<String>,
    pub ip_address_type: Option<IpAddressType>,
    pub snapshot_options: Option<SnapshotOptions>,
    pub vpc_options: Option<VpcOptions>,
    pub cognito_options: Option<CognitoOptions>,
    pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
    pub node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>,
    pub advanced_options: Option<HashMap<String, String>>,
    pub log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>,
    pub domain_endpoint_options: Option<DomainEndpointOptions>,
    pub advanced_security_options: Option<AdvancedSecurityOptionsInput>,
    pub tag_list: Option<Vec<Tag>>,
    pub auto_tune_options: Option<AutoTuneOptionsInput>,
    pub off_peak_window_options: Option<OffPeakWindowOptions>,
    pub software_update_options: Option<SoftwareUpdateOptions>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_name: Option<String>

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.

engine_version: Option<String>

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.

cluster_config: Option<ClusterConfig>

Container for the cluster configuration of a domain.

ebs_options: Option<EbsOptions>

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

access_policies: Option<String>

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

ip_address_type: Option<IpAddressType>

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

snapshot_options: Option<SnapshotOptions>

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

vpc_options: Option<VpcOptions>

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.

cognito_options: Option<CognitoOptions>

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

encryption_at_rest_options: Option<EncryptionAtRestOptions>

Key-value pairs to enable encryption at rest.

node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>

Enables node-to-node encryption.

advanced_options: Option<HashMap<String, String>>

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.

log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>

Key-value pairs to configure log publishing.

domain_endpoint_options: Option<DomainEndpointOptions>

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

advanced_security_options: Option<AdvancedSecurityOptionsInput>

Options for fine-grained access control.

tag_list: Option<Vec<Tag>>

List of tags to add to the domain upon creation.

auto_tune_options: Option<AutoTuneOptionsInput>

Options for Auto-Tune.

off_peak_window_options: Option<OffPeakWindowOptions>

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

software_update_options: Option<SoftwareUpdateOptions>

Software update options for the domain.

Implementations

impl CreateDomainInput

pub fn domain_name(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&ClusterConfig>

Container for the cluster configuration of a domain.

pub fn ebs_options(&self) -> Option<&EbsOptions>

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

pub fn access_policies(&self) -> Option<&str>

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

pub fn ip_address_type(&self) -> Option<&IpAddressType>

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

pub fn snapshot_options(&self) -> Option<&SnapshotOptions>

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

pub fn vpc_options(&self) -> Option<&VpcOptions>

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) -> Option<&CognitoOptions>

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) -> Option<&EncryptionAtRestOptions>

Key-value pairs to enable encryption at rest.

pub fn node_to_node_encryption_options( &self ) -> Option<&NodeToNodeEncryptionOptions>

Enables node-to-node encryption.

pub fn advanced_options(&self) -> Option<&HashMap<String, String>>

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 ) -> Option<&HashMap<LogType, LogPublishingOption>>

Key-value pairs to configure log publishing.

pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>

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

pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>

Options for fine-grained access control.

pub fn tag_list(&self) -> &[Tag]

List of tags to add to the domain upon creation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_list.is_none().

pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsInput>

Options for Auto-Tune.

pub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>

Software update options for the domain.

impl CreateDomainInput

pub fn builder() -> CreateDomainInputBuilder

Creates a new builder-style object to manufacture CreateDomainInput.

Trait Implementations

impl Clone for CreateDomainInput

fn clone(&self) -> CreateDomainInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDomainInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDomainInput

fn eq(&self, other: &CreateDomainInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDomainInput