Struct aws_sdk_opensearch::types::builders::DomainStatusBuilder

#[non_exhaustive]
pub struct DomainStatusBuilder { /* private fields */ }

A builder for DomainStatus.

Implementations

impl DomainStatusBuilder

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

Unique identifier for the domain.

This field is required.

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

Unique identifier for the domain.

pub fn get_domain_id(&self) -> &Option<String>

Unique identifier for the domain.

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

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

This field is required.

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

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

pub fn get_domain_name(&self) -> &Option<String>

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

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

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

This field is required.

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

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

pub fn get_arn(&self) -> &Option<String>

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

pub fn created(self, input: bool) -> Self

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

pub fn set_created(self, input: Option<bool>) -> Self

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

pub fn get_created(&self) -> &Option<bool>

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

pub fn deleted(self, input: bool) -> Self

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.

pub fn set_deleted(self, input: Option<bool>) -> Self

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.

pub fn get_deleted(&self) -> &Option<bool>

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.

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

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

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

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

pub fn get_endpoint(&self) -> &Option<String>

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

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

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

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

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

pub fn get_endpoint_v2(&self) -> &Option<String>

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

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

Adds a key-value pair to endpoints.

To override the contents of this collection use set_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'.

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

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'.

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

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'.

pub fn processing(self, input: bool) -> Self

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

pub fn set_processing(self, input: Option<bool>) -> Self

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

pub fn get_processing(&self) -> &Option<bool>

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

pub fn upgrade_processing(self, input: bool) -> Self

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.

pub fn set_upgrade_processing(self, input: Option<bool>) -> Self

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.

pub fn get_upgrade_processing(&self) -> &Option<bool>

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.

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

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

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

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

pub fn get_engine_version(&self) -> &Option<String>

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

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

Container for the cluster configuration of the domain.

This field is required.

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

Container for the cluster configuration of the domain.

pub fn get_cluster_config(&self) -> &Option<ClusterConfig>

Container for the cluster configuration of the domain.

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

Container for EBS-based storage settings for the domain.

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

Container for EBS-based storage settings for the domain.

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

Container for EBS-based storage settings for the domain.

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

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

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

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

pub fn get_access_policies(&self) -> &Option<String>

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

pub fn ip_address_type(self, input: IpAddressType) -> Self

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

pub fn set_ip_address_type(self, input: Option<IpAddressType>) -> Self

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

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

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

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

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

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

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

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

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

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

The VPC configuration for the domain.

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

The VPC configuration for the domain.

pub fn get_vpc_options(&self) -> &Option<VpcDerivedInfo>

The VPC configuration for the domain.

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

Key-value pairs to configure 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 OpenSearch Dashboards.

pub fn get_cognito_options(&self) -> &Option<CognitoOptions>

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

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

Encryption at rest settings for the domain.

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

Encryption at rest settings for the domain.

pub fn get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>

Encryption at rest settings for the domain.

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

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

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

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

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

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

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

Adds a key-value pair to advanced_options.

To override the contents of this collection use set_advanced_options.

Key-value pairs that specify advanced configuration options.

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

Key-value pairs that specify advanced configuration options.

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

Key-value pairs that specify advanced configuration options.

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

Adds a key-value pair to log_publishing_options.

To override the contents of this collection use set_log_publishing_options.

Log publishing options for the domain.

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

Log publishing options for the domain.

pub fn get_log_publishing_options( &self ) -> &Option<HashMap<LogType, LogPublishingOption>>

Log publishing options for the domain.

pub fn service_software_options(self, input: ServiceSoftwareOptions) -> Self

The current status of the domain's service software.

pub fn set_service_software_options( self, input: Option<ServiceSoftwareOptions> ) -> Self

The current status of the domain's service software.

pub fn get_service_software_options(&self) -> &Option<ServiceSoftwareOptions>

The current status of the domain's service software.

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 get_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, input: AdvancedSecurityOptions) -> Self

Settings for fine-grained access control.

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

Settings for fine-grained access control.

pub fn get_advanced_security_options(&self) -> &Option<AdvancedSecurityOptions>

Settings for fine-grained access control.

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

Auto-Tune settings for the domain.

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

Auto-Tune settings for the domain.

pub fn get_auto_tune_options(&self) -> &Option<AutoTuneOptionsOutput>

Auto-Tune settings for the domain.

pub fn change_progress_details(self, input: ChangeProgressDetails) -> Self

Information about a configuration change happening on the domain.

pub fn set_change_progress_details( self, input: Option<ChangeProgressDetails> ) -> Self

Information about a configuration change happening on the domain.

pub fn get_change_progress_details(&self) -> &Option<ChangeProgressDetails>

Information about a configuration change happening on the domain.

pub fn off_peak_window_options(self, input: OffPeakWindowOptions) -> Self

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

pub fn set_off_peak_window_options( self, input: Option<OffPeakWindowOptions> ) -> Self

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

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

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

pub fn software_update_options(self, input: SoftwareUpdateOptions) -> Self

Service software update options for the domain.

pub fn set_software_update_options( self, input: Option<SoftwareUpdateOptions> ) -> Self

Service software update options for the domain.

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

Service software update options for the domain.

pub fn build(self) -> Result<DomainStatus, BuildError>

Consumes the builder and constructs a DomainStatus. This method will fail if any of the following fields are not set:

• domain_id
• domain_name
• arn

Trait Implementations

impl Clone for DomainStatusBuilder

fn clone(&self) -> DomainStatusBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainStatusBuilder

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

Formats the value using the given formatter.

impl Default for DomainStatusBuilder

fn default() -> DomainStatusBuilder

Returns the “default value” for a type.

impl PartialEq for DomainStatusBuilder

fn eq(&self, other: &DomainStatusBuilder) -> 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 DomainStatusBuilder