CfnObjectTypeProps

class aws_cdk.aws_customerprofiles.CfnObjectTypeProps(*, description, domain_name, object_type_name, allow_profile_creation=None, encryption_key=None, expiration_days=None, fields=None, keys=None, max_profile_object_count=None, source_last_updated_timestamp_format=None, tags=None, template_id=None)

Bases: object

Properties for defining a CfnObjectType.

Parameters:

description (str) – The description of the profile object type mapping.
domain_name (str) – The unique name of the domain.
object_type_name (str) – The name of the profile object type.
allow_profile_creation (Union[bool, IResolvable, None]) – Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. 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.
encryption_key (Optional[str]) – The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. If not specified the system will use the encryption key of the domain.
expiration_days (Union[int, float, None]) – The number of days until the data of this type expires.
fields (Union[IResolvable, Sequence[Union[IResolvable, FieldMapProperty, Dict[str, Any]]], None]) – A list of field definitions for the object type mapping.
keys (Union[IResolvable, Sequence[Union[IResolvable, KeyMapProperty, Dict[str, Any]]], None]) – A list of keys that can be used to map data to the profile or search for the profile.
max_profile_object_count (Union[int, float, None]) – The amount of profile object max count assigned to the object type.
source_last_updated_timestamp_format (Optional[str]) – The format of your sourceLastUpdatedTimestamp that was previously set up.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.
template_id (Optional[str]) – A unique identifier for the template mapping. 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_customerprofiles as customerprofiles

cfn_object_type_props = customerprofiles.CfnObjectTypeProps(
    description="description",
    domain_name="domainName",
    object_type_name="objectTypeName",

    # the properties below are optional
    allow_profile_creation=False,
    encryption_key="encryptionKey",
    expiration_days=123,
    fields=[customerprofiles.CfnObjectType.FieldMapProperty(
        name="name",
        object_type_field=customerprofiles.CfnObjectType.ObjectTypeFieldProperty(
            content_type="contentType",
            source="source",
            target="target"
        )
    )],
    keys=[customerprofiles.CfnObjectType.KeyMapProperty(
        name="name",
        object_type_key_list=[customerprofiles.CfnObjectType.ObjectTypeKeyProperty(
            field_names=["fieldNames"],
            standard_identifiers=["standardIdentifiers"]
        )]
    )],
    max_profile_object_count=123,
    source_last_updated_timestamp_format="sourceLastUpdatedTimestampFormat",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    template_id="templateId"
)

Attributes

allow_profile_creation

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.

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.