Class CfnDomain

Specifies an Amazon Connect Customer Profiles Domain.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDomain
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDomain Inherits CfnResource Implements IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 DefaultExpirationDays = 123,
                 DomainName = "domainName",

                 // the properties below are optional
                 DataStore = new DataStoreProperty {
                     Enabled = false,
                     Readiness = new ReadinessProperty {
                         Message = "message",
                         ProgressPercentage = 123
                     }
                 },
                 DeadLetterQueueUrl = "deadLetterQueueUrl",
                 DefaultEncryptionKey = "defaultEncryptionKey",
                 Matching = new MatchingProperty {
                     Enabled = false,

                     // the properties below are optional
                     AutoMerging = new AutoMergingProperty {
                         Enabled = false,

                         // the properties below are optional
                         ConflictResolution = new ConflictResolutionProperty {
                             ConflictResolvingModel = "conflictResolvingModel",

                             // the properties below are optional
                             SourceName = "sourceName"
                         },
                         Consolidation = new ConsolidationProperty {
                             MatchingAttributesList = new [] { new [] { "matchingAttributesList" } }
                         },
                         MinAllowedConfidenceScoreForMerging = 123
                     },
                     ExportingConfig = new ExportingConfigProperty {
                         S3Exporting = new S3ExportingConfigProperty {
                             S3BucketName = "s3BucketName",

                             // the properties below are optional
                             S3KeyName = "s3KeyName"
                         }
                     },
                     JobSchedule = new JobScheduleProperty {
                         DayOfTheWeek = "dayOfTheWeek",
                         Time = "time"
                     }
                 },
                 RuleBasedMatching = new RuleBasedMatchingProperty {
                     Enabled = false,

                     // the properties below are optional
                     AttributeTypesSelector = new AttributeTypesSelectorProperty {
                         AttributeMatchingModel = "attributeMatchingModel",

                         // the properties below are optional
                         Address = new [] { "address" },
                         EmailAddress = new [] { "emailAddress" },
                         PhoneNumber = new [] { "phoneNumber" }
                     },
                     ConflictResolution = new ConflictResolutionProperty {
                         ConflictResolvingModel = "conflictResolvingModel",

                         // the properties below are optional
                         SourceName = "sourceName"
                     },
                     ExportingConfig = new ExportingConfigProperty {
                         S3Exporting = new S3ExportingConfigProperty {
                             S3BucketName = "s3BucketName",

                             // the properties below are optional
                             S3KeyName = "s3KeyName"
                         }
                     },
                     MatchingRules = new [] { new MatchingRuleProperty {
                         Rule = new [] { "rule" }
                     } },
                     MaxAllowedRuleLevelForMatching = 123,
                     MaxAllowedRuleLevelForMerging = 123,
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::CustomerProfiles::Domain.

Properties

AttrCreatedAt

The timestamp of when the domain was created.
AttrDataStoreReadiness

Progress information for data store setup.
AttrLastUpdatedAt

The timestamp of when the domain was most recently edited.
AttrRuleBasedMatchingStatus

The status of rule-based matching rule.
AttrStats

Usage-specific statistics about the domain.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Specifies an Amazon Connect Customer Profiles Domain.
CfnPropertyNames

Specifies an Amazon Connect Customer Profiles Domain.
DataStore

Configuration and status of the data store for the domain.
DeadLetterQueueUrl

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
DefaultEncryptionKey

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
DefaultExpirationDays

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

The unique name of the domain.
DomainRef

A reference to a Domain resource.
Matching

The process of matching duplicate profiles.
RuleBasedMatching

The process of matching duplicate profiles using Rule-Based matching.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

Methods

ArnForDomain(IDomainRef)

Specifies an Amazon Connect Customer Profiles Domain.
FromDomainName(Construct, string, string)

Creates a new IDomainRef from a domainName.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDomain(object)

Checks whether the given object is a CfnDomain.
RenderProperties(IDictionary<string, object>)

Specifies an Amazon Connect Customer Profiles Domain.

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::CustomerProfiles::Domain.

public CfnDomain(Construct scope, string id, ICfnDomainProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDomainProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

The timestamp of when the domain was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrDataStoreReadiness

Progress information for data store setup.

public virtual IResolvable AttrDataStoreReadiness { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: DataStore.Readiness

AttrLastUpdatedAt

The timestamp of when the domain was most recently edited.

public virtual string AttrLastUpdatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: LastUpdatedAt

AttrRuleBasedMatchingStatus

The status of rule-based matching rule.

public virtual string AttrRuleBasedMatchingStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: RuleBasedMatching.Status

AttrStats

Usage-specific statistics about the domain.

public virtual IResolvable AttrStats { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Stats

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an Amazon Connect Customer Profiles Domain.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

CfnPropertyNames

Specifies an Amazon Connect Customer Profiles Domain.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

DataStore

Configuration and status of the data store for the domain.

public virtual object? DataStore { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IDataStoreProperty

DeadLetterQueueUrl

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

public virtual string? DeadLetterQueueUrl { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

DefaultEncryptionKey

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.

public virtual string? DefaultEncryptionKey { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

DefaultExpirationDays

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

public virtual double DefaultExpirationDays { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

DomainName

The unique name of the domain.

public virtual string DomainName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

DomainRef

A reference to a Domain resource.

public virtual IDomainReference DomainRef { get; }
Property Value

IDomainReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Matching

The process of matching duplicate profiles.

public virtual object? Matching { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IMatchingProperty

RuleBasedMatching

The process of matching duplicate profiles using Rule-Based matching.

public virtual object? RuleBasedMatching { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IRuleBasedMatchingProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Methods

ArnForDomain(IDomainRef)

Specifies an Amazon Connect Customer Profiles Domain.

public static string ArnForDomain(IDomainRef resource)
Parameters
resource IDomainRef
Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 DefaultExpirationDays = 123,
                 DomainName = "domainName",

                 // the properties below are optional
                 DataStore = new DataStoreProperty {
                     Enabled = false,
                     Readiness = new ReadinessProperty {
                         Message = "message",
                         ProgressPercentage = 123
                     }
                 },
                 DeadLetterQueueUrl = "deadLetterQueueUrl",
                 DefaultEncryptionKey = "defaultEncryptionKey",
                 Matching = new MatchingProperty {
                     Enabled = false,

                     // the properties below are optional
                     AutoMerging = new AutoMergingProperty {
                         Enabled = false,

                         // the properties below are optional
                         ConflictResolution = new ConflictResolutionProperty {
                             ConflictResolvingModel = "conflictResolvingModel",

                             // the properties below are optional
                             SourceName = "sourceName"
                         },
                         Consolidation = new ConsolidationProperty {
                             MatchingAttributesList = new [] { new [] { "matchingAttributesList" } }
                         },
                         MinAllowedConfidenceScoreForMerging = 123
                     },
                     ExportingConfig = new ExportingConfigProperty {
                         S3Exporting = new S3ExportingConfigProperty {
                             S3BucketName = "s3BucketName",

                             // the properties below are optional
                             S3KeyName = "s3KeyName"
                         }
                     },
                     JobSchedule = new JobScheduleProperty {
                         DayOfTheWeek = "dayOfTheWeek",
                         Time = "time"
                     }
                 },
                 RuleBasedMatching = new RuleBasedMatchingProperty {
                     Enabled = false,

                     // the properties below are optional
                     AttributeTypesSelector = new AttributeTypesSelectorProperty {
                         AttributeMatchingModel = "attributeMatchingModel",

                         // the properties below are optional
                         Address = new [] { "address" },
                         EmailAddress = new [] { "emailAddress" },
                         PhoneNumber = new [] { "phoneNumber" }
                     },
                     ConflictResolution = new ConflictResolutionProperty {
                         ConflictResolvingModel = "conflictResolvingModel",

                         // the properties below are optional
                         SourceName = "sourceName"
                     },
                     ExportingConfig = new ExportingConfigProperty {
                         S3Exporting = new S3ExportingConfigProperty {
                             S3BucketName = "s3BucketName",

                             // the properties below are optional
                             S3KeyName = "s3KeyName"
                         }
                     },
                     MatchingRules = new [] { new MatchingRuleProperty {
                         Rule = new [] { "rule" }
                     } },
                     MaxAllowedRuleLevelForMatching = 123,
                     MaxAllowedRuleLevelForMerging = 123,
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromDomainName(Construct, string, string)

Creates a new IDomainRef from a domainName.

public static IDomainRef FromDomainName(Construct scope, string id, string domainName)
Parameters
scope Construct
id string
domainName string
Returns

IDomainRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

IsCfnDomain(object)

Checks whether the given object is a CfnDomain.

public static bool IsCfnDomain(object x)
Parameters
x object
Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an Amazon Connect Customer Profiles Domain.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

CloudformationResource: AWS::CustomerProfiles::Domain

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable