Interface ICfnObjectTypeMixinProps

Properties for CfnObjectTypePropsMixin.

Namespace: Amazon.CDK.Mixins.Preview.AWS.CustomerProfiles.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface ICfnObjectTypeMixinProps

Syntax (vb)

Public Interface ICfnObjectTypeMixinProps

Remarks

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

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.Mixins.Preview.AWS.CustomerProfiles.Mixins;

             var cfnObjectTypeMixinProps = new CfnObjectTypeMixinProps {
                 AllowProfileCreation = false,
                 Description = "description",
                 DomainName = "domainName",
                 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,
                 ObjectTypeName = "objectTypeName",
                 SourceLastUpdatedTimestampFormat = "sourceLastUpdatedTimestampFormat",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateId = "templateId"
             };

Synopsis

Properties

AllowProfileCreation	Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
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	The tags used to organize, track, or control access for this resource.
TemplateId	A unique identifier for the template 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.

object? AllowProfileCreation { get; }

Property Value

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.

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

Type union: either bool or IResolvable

Description

The description of the profile object type mapping.

string? Description { get; }

Property Value

string

Remarks

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

DomainName

The unique name of the domain.

string? DomainName { get; }

Property Value

string

Remarks

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

EncryptionKey

The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.

string? EncryptionKey { get; }

Property Value

string

Remarks

If not specified the system will use the encryption key of the domain.

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

ExpirationDays

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

double? ExpirationDays { get; }

Property Value

double?

Remarks

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

Fields

A list of field definitions for the object type mapping.

object? Fields { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnObjectTypePropsMixin.IFieldMapProperty)[]

Keys

A list of keys that can be used to map data to the profile or search for the profile.

object? Keys { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnObjectTypePropsMixin.IKeyMapProperty)[]

MaxProfileObjectCount

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

double? MaxProfileObjectCount { get; }

Property Value

double?

Remarks

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

ObjectTypeName

The name of the profile object type.

string? ObjectTypeName { get; }

Property Value

string

Remarks

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

SourceLastUpdatedTimestampFormat

The format of your sourceLastUpdatedTimestamp that was previously set up.

string? SourceLastUpdatedTimestampFormat { get; }

Property Value

string

Remarks

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

TemplateId

A unique identifier for the template mapping.

string? TemplateId { get; }

Property Value

string

Remarks

This can be used instead of specifying the Keys and Fields properties directly.

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