Class CfnObjectType
A CloudFormation AWS::CustomerProfiles::ObjectType
.
Inherited Members
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.AWS.CustomerProfiles.dll
Syntax (csharp)
public class CfnObjectType : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnObjectType
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an Amazon Connect Customer Profiles Object Type Mapping.
CloudformationResource: AWS::CustomerProfiles::ObjectType
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 cfnObjectType = new CfnObjectType(this, "MyCfnObjectType", new CfnObjectTypeProps {
DomainName = "domainName",
// the properties below are optional
AllowProfileCreation = false,
Description = "description",
EncryptionKey = "encryptionKey",
ExpirationDays = 123,
Fields = new [] { new FieldMapProperty {
Name = "name",
ObjectTypeField = new ObjectTypeFieldProperty {
ContentType = "contentType",
Source = "source",
Target = "target"
}
} },
Keys = new [] { new KeyMapProperty {
Name = "name",
ObjectTypeKeyList = new [] { new ObjectTypeKeyProperty {
FieldNames = new [] { "fieldNames" },
StandardIdentifiers = new [] { "standardIdentifiers" }
} }
} },
ObjectTypeName = "objectTypeName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TemplateId = "templateId"
});
Synopsis
Constructors
CfnObjectType(Construct, String, ICfnObjectTypeProps) | Create a new |
CfnObjectType(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnObjectType(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AllowProfileCreation | Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. |
AttrCreatedAt | The timestamp of when the object type was created. |
AttrLastUpdatedAt | The timestamp of when the object type was most recently edited. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the profile object type mapping. |
DomainName | The unique name of the domain. |
EncryptionKey | The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. |
ExpirationDays | The number of days until the data of this type expires. |
Fields | A list of field definitions for the object type mapping. |
Keys | A list of keys that can be used to map data to the profile or search for the profile. |
ObjectTypeName | The name of the profile object type. |
Tags | The tags used to organize, track, or control access for this resource. |
TemplateId | A unique identifier for the template mapping. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnObjectType(Construct, String, ICfnObjectTypeProps)
Create a new AWS::CustomerProfiles::ObjectType
.
public CfnObjectType(Construct scope, string id, ICfnObjectTypeProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnObjectTypeProps
- resource properties.
CfnObjectType(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnObjectType(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnObjectType(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnObjectType(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AllowProfileCreation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
public virtual object AllowProfileCreation { get; set; }
Property Value
System.Object
Remarks
The default is FALSE
. If the AllowProfileCreation flag is set to FALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE
, and if no match is found, then the service creates a new standard profile.
AttrCreatedAt
The timestamp of when the object type was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrLastUpdatedAt
The timestamp of when the object type 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
Description
The description of the profile object type mapping.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DomainName
The unique name of the domain.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
EncryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
public virtual string EncryptionKey { get; set; }
Property Value
System.String
Remarks
If not specified the system will use the encryption key of the domain.
ExpirationDays
The number of days until the data of this type expires.
public virtual Nullable<double> ExpirationDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Fields
A list of field definitions for the object type mapping.
public virtual object Fields { get; set; }
Property Value
System.Object
Remarks
Keys
A list of keys that can be used to map data to the profile or search for the profile.
public virtual object Keys { get; set; }
Property Value
System.Object
Remarks
ObjectTypeName
The name of the profile object type.
public virtual string ObjectTypeName { 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
TemplateId
A unique identifier for the template mapping.
public virtual string TemplateId { get; set; }
Property Value
System.String
Remarks
This can be used instead of specifying the Keys and Fields properties directly.
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>