/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.customerprofiles.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateDomainRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The unique name of the domain. *
*/ private String domainName; /** ** The default number of days until the data within the domain expires. *
*/ private Integer defaultExpirationDays; /** ** 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. *
*/ private String defaultEncryptionKey; /** ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from * third party applications. 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. *
*/ private String deadLetterQueueUrl; /** *
* The process of matching duplicate profiles. If Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches API to
* return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
*
* The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching
=
* true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your
* configuration in the RuleBasedMatchingRequest
. You can use the ListRuleBasedMatches
and
* GetSimilarProfiles
API to return and review the results. Also, if you have configured
* ExportingConfig
in the RuleBasedMatchingRequest
, you can download the results from S3.
*
* The tags used to organize, track, or control access for this resource. *
*/ private java.util.Map* The unique name of the domain. *
* * @param domainName * The unique name of the domain. */ public void setDomainName(String domainName) { this.domainName = domainName; } /** ** The unique name of the domain. *
* * @return The unique name of the domain. */ public String getDomainName() { return this.domainName; } /** ** The unique name of the domain. *
* * @param domainName * The unique name of the domain. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withDomainName(String domainName) { setDomainName(domainName); return this; } /** ** The default number of days until the data within the domain expires. *
* * @param defaultExpirationDays * The default number of days until the data within the domain expires. */ public void setDefaultExpirationDays(Integer defaultExpirationDays) { this.defaultExpirationDays = defaultExpirationDays; } /** ** The default number of days until the data within the domain expires. *
* * @return The default number of days until the data within the domain expires. */ public Integer getDefaultExpirationDays() { return this.defaultExpirationDays; } /** ** The default number of days until the data within the domain expires. *
* * @param defaultExpirationDays * The default number of days until the data within the domain expires. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withDefaultExpirationDays(Integer defaultExpirationDays) { setDefaultExpirationDays(defaultExpirationDays); return this; } /** ** 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. *
* * @param defaultEncryptionKey * 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. */ public void setDefaultEncryptionKey(String defaultEncryptionKey) { this.defaultEncryptionKey = defaultEncryptionKey; } /** ** 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. *
* * @return 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. */ public String getDefaultEncryptionKey() { return this.defaultEncryptionKey; } /** ** 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. *
* * @param defaultEncryptionKey * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withDefaultEncryptionKey(String defaultEncryptionKey) { setDefaultEncryptionKey(defaultEncryptionKey); return this; } /** ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from * third party applications. 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. *
* * @param deadLetterQueueUrl * The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data * from third party applications. 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. */ public void setDeadLetterQueueUrl(String deadLetterQueueUrl) { this.deadLetterQueueUrl = deadLetterQueueUrl; } /** ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from * third party applications. 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. *
* * @return The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data * from third party applications. 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. */ public String getDeadLetterQueueUrl() { return this.deadLetterQueueUrl; } /** ** The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from * third party applications. 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. *
* * @param deadLetterQueueUrl * The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data * from third party applications. 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withDeadLetterQueueUrl(String deadLetterQueueUrl) { setDeadLetterQueueUrl(deadLetterQueueUrl); return this; } /** *
* The process of matching duplicate profiles. If Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches API to
* return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
*
Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches
* API to return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
*/
public void setMatching(MatchingRequest matching) {
this.matching = matching;
}
/**
*
* The process of matching duplicate profiles. If Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches API to
* return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
*
Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured
* ExportingConfig
in the MatchingRequest
, you can download the results from S3.
*/
public MatchingRequest getMatching() {
return this.matching;
}
/**
*
* The process of matching duplicate profiles. If Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches API to
* return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
*
Matching
= true
, 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.
*
* After the Identity Resolution Job completes, use the GetMatches
* API to return and review the results. Or, if you have configured ExportingConfig
in the
* MatchingRequest
, you can download the results from S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDomainRequest withMatching(MatchingRequest matching) {
setMatching(matching);
return this;
}
/**
*
* The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching
=
* true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your
* configuration in the RuleBasedMatchingRequest
. You can use the ListRuleBasedMatches
and
* GetSimilarProfiles
API to return and review the results. Also, if you have configured
* ExportingConfig
in the RuleBasedMatchingRequest
, you can download the results from S3.
*
RuleBasedMatching
= true, Amazon Connect Customer Profiles will start to match and merge your
* profiles according to your configuration in the RuleBasedMatchingRequest
. You can use the
* ListRuleBasedMatches
and GetSimilarProfiles
API to return and review the
* results. Also, if you have configured ExportingConfig
in the
* RuleBasedMatchingRequest
, you can download the results from S3.
*/
public void setRuleBasedMatching(RuleBasedMatchingRequest ruleBasedMatching) {
this.ruleBasedMatching = ruleBasedMatching;
}
/**
*
* The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching
=
* true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your
* configuration in the RuleBasedMatchingRequest
. You can use the ListRuleBasedMatches
and
* GetSimilarProfiles
API to return and review the results. Also, if you have configured
* ExportingConfig
in the RuleBasedMatchingRequest
, you can download the results from S3.
*
RuleBasedMatching
= true, Amazon Connect Customer Profiles will start to match and merge
* your profiles according to your configuration in the RuleBasedMatchingRequest
. You can use
* the ListRuleBasedMatches
and GetSimilarProfiles
API to return and review the
* results. Also, if you have configured ExportingConfig
in the
* RuleBasedMatchingRequest
, you can download the results from S3.
*/
public RuleBasedMatchingRequest getRuleBasedMatching() {
return this.ruleBasedMatching;
}
/**
*
* The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching
=
* true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your
* configuration in the RuleBasedMatchingRequest
. You can use the ListRuleBasedMatches
and
* GetSimilarProfiles
API to return and review the results. Also, if you have configured
* ExportingConfig
in the RuleBasedMatchingRequest
, you can download the results from S3.
*
RuleBasedMatching
= true, Amazon Connect Customer Profiles will start to match and merge your
* profiles according to your configuration in the RuleBasedMatchingRequest
. You can use the
* ListRuleBasedMatches
and GetSimilarProfiles
API to return and review the
* results. Also, if you have configured ExportingConfig
in the
* RuleBasedMatchingRequest
, you can download the results from S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDomainRequest withRuleBasedMatching(RuleBasedMatchingRequest ruleBasedMatching) {
setRuleBasedMatching(ruleBasedMatching);
return this;
}
/**
* * The tags used to organize, track, or control access for this resource. *
* * @return The tags used to organize, track, or control access for this resource. */ public java.util.Map* The tags used to organize, track, or control access for this resource. *
* * @param tags * The tags used to organize, track, or control access for this resource. */ public void setTags(java.util.Map* The tags used to organize, track, or control access for this resource. *
* * @param tags * The tags used to organize, track, or control access for this resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withTags(java.util.Map