Package software.amazon.awscdk.services.customerprofiles

Class CfnDomain.Builder

java.lang.Object

software.amazon.awscdk.services.customerprofiles.CfnDomain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomain>

Enclosing class:

CfnDomain

@Stability(Stable)
public static final class CfnDomain.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain>

A fluent builder for CfnDomain.

Method Summary

Modifier and Type	Method	Description
CfnDomain	build()
static CfnDomain.Builder	create(software.constructs.Construct scope, String id)
CfnDomain.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.
CfnDomain.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.
CfnDomain.Builder	defaultExpirationDays(Number defaultExpirationDays)	The default number of days until the data within the domain expires.
CfnDomain.Builder	domainName(String domainName)	The unique name of the domain.
CfnDomain.Builder	matching(IResolvable matching)	The process of matching duplicate profiles.
CfnDomain.Builder	matching(CfnDomain.MatchingProperty matching)	The process of matching duplicate profiles.
CfnDomain.Builder	ruleBasedMatching(IResolvable ruleBasedMatching)	The process of matching duplicate profiles using the Rule-Based matching.
CfnDomain.Builder	ruleBasedMatching(CfnDomain.RuleBasedMatchingProperty ruleBasedMatching)	The process of matching duplicate profiles using the Rule-Based matching.
CfnDomain.Builder	tags(List<? extends CfnTag> tags)	The tags used to organize, track, or control access for this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDomain.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDomain.Builder.

domainName

@Stability(Stable)
public CfnDomain.Builder domainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-domainname

deadLetterQueueUrl

@Stability(Stable)
public CfnDomain.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-deadletterqueueurl

defaultEncryptionKey

@Stability(Stable)
public CfnDomain.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultencryptionkey

defaultExpirationDays

@Stability(Stable)
public CfnDomain.Builder defaultExpirationDays(Number 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultexpirationdays

matching

@Stability(Stable)
public CfnDomain.Builder matching(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-matching

matching

@Stability(Stable)
public CfnDomain.Builder matching(CfnDomain.MatchingProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-matching

ruleBasedMatching

@Stability(Stable)
public CfnDomain.Builder ruleBasedMatching(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-rulebasedmatching

ruleBasedMatching

@Stability(Stable)
public CfnDomain.Builder ruleBasedMatching(CfnDomain.RuleBasedMatchingProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-rulebasedmatching

tags

@Stability(Stable)
public CfnDomain.Builder tags(List<? extends CfnTag> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-tags

build

@Stability(Stable)
public CfnDomain build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain>

Returns:

a newly built instance of CfnDomain.