#[non_exhaustive]pub struct CreateDomainInput {Show 21 fields
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 identity_center_options: Option<IdentityCenterOptionsInput>,
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>,
pub aiml_options: Option<AimlOptionsInput>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
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 aTooManyClauseserror. -
"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.
identity_center_options: Option<IdentityCenterOptionsInput>Configuration options for enabling and managing IAM Identity Center integration within a domain.
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.
aiml_options: Option<AimlOptionsInput>Options for all machine learning features for the specified domain.
Implementations§
Source§impl CreateDomainInput
impl CreateDomainInput
Sourcepub fn domain_name(&self) -> Option<&str>
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.
Sourcepub fn engine_version(&self) -> Option<&str>
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.
Sourcepub fn cluster_config(&self) -> Option<&ClusterConfig>
pub fn cluster_config(&self) -> Option<&ClusterConfig>
Container for the cluster configuration of a domain.
Sourcepub fn ebs_options(&self) -> Option<&EbsOptions>
pub fn ebs_options(&self) -> Option<&EbsOptions>
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
Sourcepub fn access_policies(&self) -> Option<&str>
pub fn access_policies(&self) -> Option<&str>
Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
Sourcepub fn ip_address_type(&self) -> Option<&IpAddressType>
pub fn ip_address_type(&self) -> Option<&IpAddressType>
Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
Sourcepub fn snapshot_options(&self) -> Option<&SnapshotOptions>
pub fn snapshot_options(&self) -> Option<&SnapshotOptions>
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
Sourcepub fn vpc_options(&self) -> Option<&VpcOptions>
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.
Sourcepub fn cognito_options(&self) -> Option<&CognitoOptions>
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.
Sourcepub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
Key-value pairs to enable encryption at rest.
Sourcepub fn node_to_node_encryption_options(
&self,
) -> Option<&NodeToNodeEncryptionOptions>
pub fn node_to_node_encryption_options( &self, ) -> Option<&NodeToNodeEncryptionOptions>
Enables node-to-node encryption.
Sourcepub fn advanced_options(&self) -> Option<&HashMap<String, String>>
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 aTooManyClauseserror. -
"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.
Sourcepub fn log_publishing_options(
&self,
) -> Option<&HashMap<LogType, LogPublishingOption>>
pub fn log_publishing_options( &self, ) -> Option<&HashMap<LogType, LogPublishingOption>>
Key-value pairs to configure log publishing.
Sourcepub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Sourcepub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>
pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>
Options for fine-grained access control.
Sourcepub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsInput>
pub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsInput>
Configuration options for enabling and managing IAM Identity Center integration within a domain.
Sourcepub fn tag_list(&self) -> &[Tag]
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().
Sourcepub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsInput>
pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsInput>
Options for Auto-Tune.
Sourcepub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>
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.
Sourcepub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>
pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>
Software update options for the domain.
Sourcepub fn aiml_options(&self) -> Option<&AimlOptionsInput>
pub fn aiml_options(&self) -> Option<&AimlOptionsInput>
Options for all machine learning features for the specified domain.
Source§impl CreateDomainInput
impl CreateDomainInput
Sourcepub fn builder() -> CreateDomainInputBuilder
pub fn builder() -> CreateDomainInputBuilder
Creates a new builder-style object to manufacture CreateDomainInput.
Trait Implementations§
Source§impl Clone for CreateDomainInput
impl Clone for CreateDomainInput
Source§fn clone(&self) -> CreateDomainInput
fn clone(&self) -> CreateDomainInput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateDomainInput
impl Debug for CreateDomainInput
Source§impl PartialEq for CreateDomainInput
impl PartialEq for CreateDomainInput
impl StructuralPartialEq for CreateDomainInput
Auto Trait Implementations§
impl Freeze for CreateDomainInput
impl RefUnwindSafe for CreateDomainInput
impl Send for CreateDomainInput
impl Sync for CreateDomainInput
impl Unpin for CreateDomainInput
impl UnwindSafe for CreateDomainInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);