Class CfnObjectType

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnObjectType

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnObjectType : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnObjectType Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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

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 {
                 Description = "description",
                 DomainName = "domainName",
                 ObjectTypeName = "objectTypeName",

                 // the properties below are optional
                 AllowProfileCreation = false,
                 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" }
                     } }
                 } },
                 MaxProfileObjectCount = 123,
                 SourceLastUpdatedTimestampFormat = "sourceLastUpdatedTimestampFormat",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateId = "templateId"
             });

Synopsis

Constructors

CfnObjectType(Construct, string, ICfnObjectTypeProps)

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

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.
AttrMaxAvailableProfileObjectCount	The amount of provisioned profile object max count available.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Specifies an Amazon Connect Customer Profiles Object Type Mapping.
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.
MaxProfileObjectCount	The amount of profile object max count assigned to the object type.
ObjectTypeName	The name of the profile object type.
SourceLastUpdatedTimestampFormat	The format of your sourceLastUpdatedTimestamp that was previously set up.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	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>)	Specifies an Amazon Connect Customer Profiles Object Type Mapping.

Constructors

CfnObjectType(Construct, string, ICfnObjectTypeProps)

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

public CfnObjectType(Construct scope, string id, ICfnObjectTypeProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnObjectTypeProps: Resource properties.

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

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

object

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

AttrCreatedAt

The timestamp of when the object type was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrLastUpdatedAt

The timestamp of when the object type was most recently edited.

public virtual string AttrLastUpdatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: LastUpdatedAt

AttrMaxAvailableProfileObjectCount

The amount of provisioned profile object max count available.

public virtual double AttrMaxAvailableProfileObjectCount { get; }

Property Value

double

Remarks

CloudformationAttribute: MaxAvailableProfileObjectCount

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-objecttype.html

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

Description

The description of the profile object type mapping.

public virtual string Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

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-objecttype.html

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

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

string

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

ExpirationDays

The number of days until the data of this type expires.

public virtual double? ExpirationDays { get; set; }

Property Value

double?

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

Fields

A list of field definitions for the object type mapping.

public virtual object? Fields { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

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

object

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

MaxProfileObjectCount

The amount of profile object max count assigned to the object type.

public virtual double? MaxProfileObjectCount { get; set; }

Property Value

double?

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

ObjectTypeName

The name of the profile object type.

public virtual string ObjectTypeName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

SourceLastUpdatedTimestampFormat

The format of your sourceLastUpdatedTimestamp that was previously set up.

public virtual string? SourceLastUpdatedTimestampFormat { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

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-objecttype.html

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

TemplateId

A unique identifier for the template mapping.

public virtual string? TemplateId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::CustomerProfiles::ObjectType

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable