CfnObjectTypeProps

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

Bases: object

Properties for defining a CfnObjectType.

Parameters
  • domain_name (str) – The unique name of the domain.

  • 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.

  • description (Optional[str]) – The description of the profile object type mapping.

  • 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.

  • object_type_name (Optional[str]) – The name of the profile object type.

  • 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.

Link

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.
import aws_cdk.aws_customerprofiles as customerprofiles

cfn_object_type_props = customerprofiles.CfnObjectTypeProps(
    domain_name="domainName",

    # the properties below are optional
    allow_profile_creation=False,
    description="description",
    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"]
        )]
    )],
    object_type_name="objectTypeName",
    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.

Link

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

Return type

Union[bool, IResolvable, None]

description

The description of the profile object type mapping.

Link

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

Return type

Optional[str]

domain_name

The unique name of the domain.

Link

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

Return type

str

encryption_key

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.

Link

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

Return type

Optional[str]

expiration_days

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

Link

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

Return type

Union[int, float, None]

fields

A list of field definitions for the object type mapping.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, FieldMapProperty]], None]

keys

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, KeyMapProperty]], None]

object_type_name

The name of the profile object type.

Link

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

Return type

Optional[str]

tags

The tags used to organize, track, or control access for this resource.

Link

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

Return type

Optional[List[CfnTag]]

template_id

A unique identifier for the template mapping.

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

Link

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

Return type

Optional[str]