pub struct Builder { /* private fields */ }
Expand description

A builder for CreateDomainInput.

Implementations§

The name of the Amazon OpenSearch Service domain you're 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).

Examples found in repository?
src/client.rs (line 1003)
1002
1003
1004
1005
        pub fn domain_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.domain_name(input.into());
            self
        }

The name of the Amazon OpenSearch Service domain you're 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).

Examples found in repository?
src/client.rs (line 1008)
1007
1008
1009
1010
        pub fn set_domain_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_domain_name(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1013)
1012
1013
1014
1015
        pub fn engine_version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.engine_version(input.into());
            self
        }

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

Examples found in repository?
src/client.rs (line 1021)
1017
1018
1019
1020
1021
1022
1023
        pub fn set_engine_version(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_engine_version(input);
            self
        }

Configuration options for a domain. Specifies the instance type and number of instances in the domain.

Examples found in repository?
src/client.rs (line 1026)
1025
1026
1027
1028
        pub fn cluster_config(mut self, input: crate::model::ClusterConfig) -> Self {
            self.inner = self.inner.cluster_config(input);
            self
        }

Configuration options for a domain. Specifies the instance type and number of instances in the domain.

Examples found in repository?
src/client.rs (line 1034)
1030
1031
1032
1033
1034
1035
1036
        pub fn set_cluster_config(
            mut self,
            input: std::option::Option<crate::model::ClusterConfig>,
        ) -> Self {
            self.inner = self.inner.set_cluster_config(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1039)
1038
1039
1040
1041
        pub fn ebs_options(mut self, input: crate::model::EbsOptions) -> Self {
            self.inner = self.inner.ebs_options(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1047)
1043
1044
1045
1046
1047
1048
1049
        pub fn set_ebs_options(
            mut self,
            input: std::option::Option<crate::model::EbsOptions>,
        ) -> Self {
            self.inner = self.inner.set_ebs_options(input);
            self
        }

IAM access policy as a JSON-formatted string.

Examples found in repository?
src/client.rs (line 1052)
1051
1052
1053
1054
        pub fn access_policies(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.access_policies(input.into());
            self
        }

IAM access policy as a JSON-formatted string.

Examples found in repository?
src/client.rs (line 1060)
1056
1057
1058
1059
1060
1061
1062
        pub fn set_access_policies(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_access_policies(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1065)
1064
1065
1066
1067
        pub fn snapshot_options(mut self, input: crate::model::SnapshotOptions) -> Self {
            self.inner = self.inner.snapshot_options(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1073)
1069
1070
1071
1072
1073
1074
1075
        pub fn set_snapshot_options(
            mut self,
            input: std::option::Option<crate::model::SnapshotOptions>,
        ) -> Self {
            self.inner = self.inner.set_snapshot_options(input);
            self
        }

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

Examples found in repository?
src/client.rs (line 1078)
1077
1078
1079
1080
        pub fn vpc_options(mut self, input: crate::model::VpcOptions) -> Self {
            self.inner = self.inner.vpc_options(input);
            self
        }

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

Examples found in repository?
src/client.rs (line 1086)
1082
1083
1084
1085
1086
1087
1088
        pub fn set_vpc_options(
            mut self,
            input: std::option::Option<crate::model::VpcOptions>,
        ) -> Self {
            self.inner = self.inner.set_vpc_options(input);
            self
        }

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Examples found in repository?
src/client.rs (line 1091)
1090
1091
1092
1093
        pub fn cognito_options(mut self, input: crate::model::CognitoOptions) -> Self {
            self.inner = self.inner.cognito_options(input);
            self
        }

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Examples found in repository?
src/client.rs (line 1099)
1095
1096
1097
1098
1099
1100
1101
        pub fn set_cognito_options(
            mut self,
            input: std::option::Option<crate::model::CognitoOptions>,
        ) -> Self {
            self.inner = self.inner.set_cognito_options(input);
            self
        }

Options for encryption of data at rest.

Examples found in repository?
src/client.rs (line 1107)
1103
1104
1105
1106
1107
1108
1109
        pub fn encryption_at_rest_options(
            mut self,
            input: crate::model::EncryptionAtRestOptions,
        ) -> Self {
            self.inner = self.inner.encryption_at_rest_options(input);
            self
        }

Options for encryption of data at rest.

Examples found in repository?
src/client.rs (line 1115)
1111
1112
1113
1114
1115
1116
1117
        pub fn set_encryption_at_rest_options(
            mut self,
            input: std::option::Option<crate::model::EncryptionAtRestOptions>,
        ) -> Self {
            self.inner = self.inner.set_encryption_at_rest_options(input);
            self
        }

Node-to-node encryption options.

Examples found in repository?
src/client.rs (line 1123)
1119
1120
1121
1122
1123
1124
1125
        pub fn node_to_node_encryption_options(
            mut self,
            input: crate::model::NodeToNodeEncryptionOptions,
        ) -> Self {
            self.inner = self.inner.node_to_node_encryption_options(input);
            self
        }

Node-to-node encryption options.

Examples found in repository?
src/client.rs (line 1131)
1127
1128
1129
1130
1131
1132
1133
        pub fn set_node_to_node_encryption_options(
            mut self,
            input: std::option::Option<crate::model::NodeToNodeEncryptionOptions>,
        ) -> Self {
            self.inner = self.inner.set_node_to_node_encryption_options(input);
            self
        }

Adds a key-value pair to advanced_options.

To override the contents of this collection use set_advanced_options.

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 Advanced cluster parameters for more information.

Examples found in repository?
src/client.rs (line 1144)
1139
1140
1141
1142
1143
1144
1145
1146
        pub fn advanced_options(
            mut self,
            k: impl Into<std::string::String>,
            v: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.advanced_options(k.into(), v.into());
            self
        }

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 Advanced cluster parameters for more information.

Examples found in repository?
src/client.rs (line 1154)
1148
1149
1150
1151
1152
1153
1154
1155
1156
        pub fn set_advanced_options(
            mut self,
            input: std::option::Option<
                std::collections::HashMap<std::string::String, std::string::String>,
            >,
        ) -> Self {
            self.inner = self.inner.set_advanced_options(input);
            self
        }

Adds a key-value pair to log_publishing_options.

To override the contents of this collection use set_log_publishing_options.

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

Examples found in repository?
src/client.rs (line 1167)
1162
1163
1164
1165
1166
1167
1168
1169
        pub fn log_publishing_options(
            mut self,
            k: crate::model::LogType,
            v: crate::model::LogPublishingOption,
        ) -> Self {
            self.inner = self.inner.log_publishing_options(k, v);
            self
        }

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

Examples found in repository?
src/client.rs (line 1177)
1171
1172
1173
1174
1175
1176
1177
1178
1179
        pub fn set_log_publishing_options(
            mut self,
            input: std::option::Option<
                std::collections::HashMap<crate::model::LogType, crate::model::LogPublishingOption>,
            >,
        ) -> Self {
            self.inner = self.inner.set_log_publishing_options(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1185)
1181
1182
1183
1184
1185
1186
1187
        pub fn domain_endpoint_options(
            mut self,
            input: crate::model::DomainEndpointOptions,
        ) -> Self {
            self.inner = self.inner.domain_endpoint_options(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 1193)
1189
1190
1191
1192
1193
1194
1195
        pub fn set_domain_endpoint_options(
            mut self,
            input: std::option::Option<crate::model::DomainEndpointOptions>,
        ) -> Self {
            self.inner = self.inner.set_domain_endpoint_options(input);
            self
        }

Specifies advanced security options.

Examples found in repository?
src/client.rs (line 1201)
1197
1198
1199
1200
1201
1202
1203
        pub fn advanced_security_options(
            mut self,
            input: crate::model::AdvancedSecurityOptionsInput,
        ) -> Self {
            self.inner = self.inner.advanced_security_options(input);
            self
        }

Specifies advanced security options.

Examples found in repository?
src/client.rs (line 1209)
1205
1206
1207
1208
1209
1210
1211
        pub fn set_advanced_security_options(
            mut self,
            input: std::option::Option<crate::model::AdvancedSecurityOptionsInput>,
        ) -> Self {
            self.inner = self.inner.set_advanced_security_options(input);
            self
        }

Appends an item to tag_list.

To override the contents of this collection use set_tag_list.

A list of Tag added during domain creation.

Examples found in repository?
src/client.rs (line 1218)
1217
1218
1219
1220
        pub fn tag_list(mut self, input: crate::model::Tag) -> Self {
            self.inner = self.inner.tag_list(input);
            self
        }

A list of Tag added during domain creation.

Examples found in repository?
src/client.rs (line 1226)
1222
1223
1224
1225
1226
1227
1228
        pub fn set_tag_list(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
        ) -> Self {
            self.inner = self.inner.set_tag_list(input);
            self
        }

Specifies Auto-Tune options.

Examples found in repository?
src/client.rs (line 1231)
1230
1231
1232
1233
        pub fn auto_tune_options(mut self, input: crate::model::AutoTuneOptionsInput) -> Self {
            self.inner = self.inner.auto_tune_options(input);
            self
        }

Specifies Auto-Tune options.

Examples found in repository?
src/client.rs (line 1239)
1235
1236
1237
1238
1239
1240
1241
        pub fn set_auto_tune_options(
            mut self,
            input: std::option::Option<crate::model::AutoTuneOptionsInput>,
        ) -> Self {
            self.inner = self.inner.set_auto_tune_options(input);
            self
        }

Consumes the builder and constructs a CreateDomainInput.

Examples found in repository?
src/client.rs (line 970)
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateDomain,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateDomainError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateDomainOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateDomainError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more