software.amazon.awssdk.services.customerprofiles.model

Interface CreateDomainRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>, CustomerProfilesRequest.Builder, SdkBuilder<CreateDomainRequest.Builder,CreateDomainRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDomainRequest

public static interface CreateDomainRequest.Builder
extends CustomerProfilesRequest.Builder, SdkPojo, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Method Summary

Modifier and Type	Method and Description
CreateDomainRequest.Builder	deadLetterQueueUrl(String deadLetterQueueUrl) The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
CreateDomainRequest.Builder	defaultEncryptionKey(String defaultEncryptionKey) The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
CreateDomainRequest.Builder	defaultExpirationDays(Integer defaultExpirationDays) The default number of days until the data within the domain expires.
CreateDomainRequest.Builder	domainName(String domainName) The unique name of the domain.
default CreateDomainRequest.Builder	matching(Consumer<MatchingRequest.Builder> matching) The process of matching duplicate profiles.
CreateDomainRequest.Builder	matching(MatchingRequest matching) The process of matching duplicate profiles.
CreateDomainRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDomainRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateDomainRequest.Builder	ruleBasedMatching(Consumer<RuleBasedMatchingRequest.Builder> ruleBasedMatching) The process of matching duplicate profiles using the Rule-Based matching.
CreateDomainRequest.Builder	ruleBasedMatching(RuleBasedMatchingRequest ruleBasedMatching) The process of matching duplicate profiles using the Rule-Based matching.
CreateDomainRequest.Builder	tags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domainName

CreateDomainRequest.Builder domainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultExpirationDays

CreateDomainRequest.Builder defaultExpirationDays(Integer defaultExpirationDays)

The default number of days until the data within the domain expires.

Parameters:

defaultExpirationDays - The default number of days until the data within the domain expires.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultEncryptionKey

CreateDomainRequest.Builder defaultEncryptionKey(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

deadLetterQueueUrl

CreateDomainRequest.Builder deadLetterQueueUrl(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

matching

CreateDomainRequest.Builder matching(MatchingRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

matching

default CreateDomainRequest.Builder matching(Consumer<MatchingRequest.Builder> 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.

This is a convenience method that creates an instance of the MatchingRequest.Builder avoiding the need to create one manually via MatchingRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matching(MatchingRequest).

Parameters:

matching - a consumer that will call methods on MatchingRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

matching(MatchingRequest)

ruleBasedMatching

CreateDomainRequest.Builder ruleBasedMatching(RuleBasedMatchingRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleBasedMatching

default CreateDomainRequest.Builder ruleBasedMatching(Consumer<RuleBasedMatchingRequest.Builder> 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.

This is a convenience method that creates an instance of the RuleBasedMatchingRequest.Builder avoiding the need to create one manually via RuleBasedMatchingRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleBasedMatching(RuleBasedMatchingRequest).

Parameters:

ruleBasedMatching - a consumer that will call methods on RuleBasedMatchingRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ruleBasedMatching(RuleBasedMatchingRequest)

tags

CreateDomainRequest.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder