CfnDomainObjectTypeProps

class aws_cdk.aws_customerprofiles.CfnDomainObjectTypeProps(*, domain_name, fields, object_type_name, description=None, encryption_key=None, tags=None)

Bases: object

Properties for defining a CfnDomainObjectType.

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

  • fields (Union[IResolvable, Mapping[str, Union[IResolvable, DomainObjectTypeFieldProperty, Dict[str, Any]]]]) – A map of the name and ObjectType field.

  • object_type_name (str) – The name of the domain object type.

  • description (Optional[str]) – Description of the domain object type.

  • encryption_key (Optional[str]) – The default encryption key.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_domain_object_type_props = customerprofiles.CfnDomainObjectTypeProps(
    domain_name="domainName",
    fields={
        "fields_key": customerprofiles.CfnDomainObjectType.DomainObjectTypeFieldProperty(
            source="source",
            target="target",

            # the properties below are optional
            content_type="contentType",
            feature_type="featureType"
        )
    },
    object_type_name="objectTypeName",

    # the properties below are optional
    description="description",
    encryption_key="encryptionKey",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

Description of the domain object type.

See:

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

domain_name

The unique name of the domain.

See:

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

encryption_key

The default encryption key.

See:

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

fields

A map of the name and ObjectType field.

See:

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

object_type_name

The name of the domain object type.

See:

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

tags

An array of key-value pairs to apply to this resource.

See:

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