// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateDomainInput {
/// <p>The unique name of the domain.</p>
pub domain_name: ::std::option::Option<::std::string::String>,
/// <p>The default number of days until the data within the domain expires.</p>
pub default_expiration_days: ::std::option::Option<i32>,
/// <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>
pub default_encryption_key: ::std::option::Option<::std::string::String>,
/// <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>
pub dead_letter_queue_url: ::std::option::Option<::std::string::String>,
/// <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p>
/// <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
pub matching: ::std::option::Option<crate::types::MatchingRequest>,
/// <p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
pub rule_based_matching: ::std::option::Option<crate::types::RuleBasedMatchingRequest>,
/// <p>Set to true to enabled data store for this domain.</p>
pub data_store: ::std::option::Option<crate::types::DataStoreRequest>,
/// <p>The tags used to organize, track, or control access for this resource.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl UpdateDomainInput {
/// <p>The unique name of the domain.</p>
pub fn domain_name(&self) -> ::std::option::Option<&str> {
self.domain_name.as_deref()
}
/// <p>The default number of days until the data within the domain expires.</p>
pub fn default_expiration_days(&self) -> ::std::option::Option<i32> {
self.default_expiration_days
}
/// <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>
pub fn default_encryption_key(&self) -> ::std::option::Option<&str> {
self.default_encryption_key.as_deref()
}
/// <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>
pub fn dead_letter_queue_url(&self) -> ::std::option::Option<&str> {
self.dead_letter_queue_url.as_deref()
}
/// <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p>
/// <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
pub fn matching(&self) -> ::std::option::Option<&crate::types::MatchingRequest> {
self.matching.as_ref()
}
/// <p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
pub fn rule_based_matching(&self) -> ::std::option::Option<&crate::types::RuleBasedMatchingRequest> {
self.rule_based_matching.as_ref()
}
/// <p>Set to true to enabled data store for this domain.</p>
pub fn data_store(&self) -> ::std::option::Option<&crate::types::DataStoreRequest> {
self.data_store.as_ref()
}
/// <p>The tags used to organize, track, or control access for this resource.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
}
impl UpdateDomainInput {
/// Creates a new builder-style object to manufacture [`UpdateDomainInput`](crate::operation::update_domain::UpdateDomainInput).
pub fn builder() -> crate::operation::update_domain::builders::UpdateDomainInputBuilder {
crate::operation::update_domain::builders::UpdateDomainInputBuilder::default()
}
}
/// A builder for [`UpdateDomainInput`](crate::operation::update_domain::UpdateDomainInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateDomainInputBuilder {
pub(crate) domain_name: ::std::option::Option<::std::string::String>,
pub(crate) default_expiration_days: ::std::option::Option<i32>,
pub(crate) default_encryption_key: ::std::option::Option<::std::string::String>,
pub(crate) dead_letter_queue_url: ::std::option::Option<::std::string::String>,
pub(crate) matching: ::std::option::Option<crate::types::MatchingRequest>,
pub(crate) rule_based_matching: ::std::option::Option<crate::types::RuleBasedMatchingRequest>,
pub(crate) data_store: ::std::option::Option<crate::types::DataStoreRequest>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl UpdateDomainInputBuilder {
/// <p>The unique name of the domain.</p>
/// This field is required.
pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.domain_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique name of the domain.</p>
pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.domain_name = input;
self
}
/// <p>The unique name of the domain.</p>
pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
&self.domain_name
}
/// <p>The default number of days until the data within the domain expires.</p>
pub fn default_expiration_days(mut self, input: i32) -> Self {
self.default_expiration_days = ::std::option::Option::Some(input);
self
}
/// <p>The default number of days until the data within the domain expires.</p>
pub fn set_default_expiration_days(mut self, input: ::std::option::Option<i32>) -> Self {
self.default_expiration_days = input;
self
}
/// <p>The default number of days until the data within the domain expires.</p>
pub fn get_default_expiration_days(&self) -> &::std::option::Option<i32> {
&self.default_expiration_days
}
/// <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>
pub fn default_encryption_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.default_encryption_key = ::std::option::Option::Some(input.into());
self
}
/// <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>
pub fn set_default_encryption_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.default_encryption_key = input;
self
}
/// <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>
pub fn get_default_encryption_key(&self) -> &::std::option::Option<::std::string::String> {
&self.default_encryption_key
}
/// <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>
pub fn dead_letter_queue_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dead_letter_queue_url = ::std::option::Option::Some(input.into());
self
}
/// <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>
pub fn set_dead_letter_queue_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dead_letter_queue_url = input;
self
}
/// <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>
pub fn get_dead_letter_queue_url(&self) -> &::std::option::Option<::std::string::String> {
&self.dead_letter_queue_url
}
/// <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p>
/// <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
pub fn matching(mut self, input: crate::types::MatchingRequest) -> Self {
self.matching = ::std::option::Option::Some(input);
self
}
/// <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p>
/// <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
pub fn set_matching(mut self, input: ::std::option::Option<crate::types::MatchingRequest>) -> Self {
self.matching = input;
self
}
/// <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p>
/// <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
pub fn get_matching(&self) -> &::std::option::Option<crate::types::MatchingRequest> {
&self.matching
}
/// <p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
pub fn rule_based_matching(mut self, input: crate::types::RuleBasedMatchingRequest) -> Self {
self.rule_based_matching = ::std::option::Option::Some(input);
self
}
/// <p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
pub fn set_rule_based_matching(mut self, input: ::std::option::Option<crate::types::RuleBasedMatchingRequest>) -> Self {
self.rule_based_matching = input;
self
}
/// <p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
pub fn get_rule_based_matching(&self) -> &::std::option::Option<crate::types::RuleBasedMatchingRequest> {
&self.rule_based_matching
}
/// <p>Set to true to enabled data store for this domain.</p>
pub fn data_store(mut self, input: crate::types::DataStoreRequest) -> Self {
self.data_store = ::std::option::Option::Some(input);
self
}
/// <p>Set to true to enabled data store for this domain.</p>
pub fn set_data_store(mut self, input: ::std::option::Option<crate::types::DataStoreRequest>) -> Self {
self.data_store = input;
self
}
/// <p>Set to true to enabled data store for this domain.</p>
pub fn get_data_store(&self) -> &::std::option::Option<crate::types::DataStoreRequest> {
&self.data_store
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags used to organize, track, or control access for this resource.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>The tags used to organize, track, or control access for this resource.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>The tags used to organize, track, or control access for this resource.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// Consumes the builder and constructs a [`UpdateDomainInput`](crate::operation::update_domain::UpdateDomainInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_domain::UpdateDomainInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_domain::UpdateDomainInput {
domain_name: self.domain_name,
default_expiration_days: self.default_expiration_days,
default_encryption_key: self.default_encryption_key,
dead_letter_queue_url: self.dead_letter_queue_url,
matching: self.matching,
rule_based_matching: self.rule_based_matching,
data_store: self.data_store,
tags: self.tags,
})
}
}