Class CfnDomain
A CloudFormation AWS::CustomerProfiles::Domain
.
Inherited Members
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.AWS.CustomerProfiles.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDomain
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an Amazon Connect Customer Profiles Domain.
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 {
DomainName = "domainName",
// the properties below are optional
DeadLetterQueueUrl = "deadLetterQueueUrl",
DefaultEncryptionKey = "defaultEncryptionKey",
DefaultExpirationDays = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDomain(Construct, String, ICfnDomainProps) | Create a new |
CfnDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrCreatedAt | The timestamp of when the domain was created. |
AttrLastUpdatedAt | The timestamp of when the domain was most recently edited. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Tags | The tags used to organize, track, or control access for this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnDomainProps
- resource properties.
CfnDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrCreatedAt
The timestamp of when the domain was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrLastUpdatedAt
The timestamp of when the domain was most recently edited.
public virtual string AttrLastUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedAt
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.String
Remarks
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.
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
System.String
Remarks
It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DefaultExpirationDays
The default number of days until the data within the domain expires.
public virtual Nullable<double> DefaultExpirationDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
DomainName
The unique name of the domain.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
Tags
The tags used to organize, track, or control access for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>