Package software.amazon.awscdk.services.customerprofiles

Interface CfnObjectTypeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnObjectTypeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.717Z")
@Stability(Stable)
public interface CfnObjectTypeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnObjectType.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.customerprofiles.*;
 CfnObjectTypeProps cfnObjectTypeProps = CfnObjectTypeProps.builder()
         .description("description")
         .domainName("domainName")
         .objectTypeName("objectTypeName")
         // the properties below are optional
         .allowProfileCreation(false)
         .encryptionKey("encryptionKey")
         .expirationDays(123)
         .fields(List.of(FieldMapProperty.builder()
                 .name("name")
                 .objectTypeField(ObjectTypeFieldProperty.builder()
                         .contentType("contentType")
                         .source("source")
                         .target("target")
                         .build())
                 .build()))
         .keys(List.of(KeyMapProperty.builder()
                 .name("name")
                 .objectTypeKeyList(List.of(ObjectTypeKeyProperty.builder()
                         .fieldNames(List.of("fieldNames"))
                         .standardIdentifiers(List.of("standardIdentifiers"))
                         .build()))
                 .build()))
         .sourceLastUpdatedTimestampFormat("sourceLastUpdatedTimestampFormat")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateId("templateId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnObjectTypeProps.Builder	A builder for CfnObjectTypeProps
static final class	CfnObjectTypeProps.Jsii$Proxy	An implementation for CfnObjectTypeProps

Method Summary

Modifier and Type	Method	Description
static CfnObjectTypeProps.Builder	builder()
default Object	getAllowProfileCreation()	Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
String	getDescription()	The description of the profile object type mapping.
String	getDomainName()	The unique name of the domain.
default String	getEncryptionKey()	The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
default Number	getExpirationDays()	The number of days until the data of this type expires.
default Object	getFields()	A list of field definitions for the object type mapping.
default Object	getKeys()	A list of keys that can be used to map data to the profile or search for the profile.
String	getObjectTypeName()	The name of the profile object type.
default String	getSourceLastUpdatedTimestampFormat()	The format of your sourceLastUpdatedTimestamp that was previously set up.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
default String	getTemplateId()	A unique identifier for the template mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description of the profile object type mapping.

See Also:

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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The unique name of the domain.

See Also:

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

getObjectTypeName

@Stability(Stable)
@NotNull
String getObjectTypeName()

The name of the profile object type.

See Also:

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

getAllowProfileCreation

@Stability(Stable)
@Nullable
default Object getAllowProfileCreation()

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.

See Also:

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

getEncryptionKey

@Stability(Stable)
@Nullable
default String getEncryptionKey()

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.

See Also:

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

getExpirationDays

@Stability(Stable)
@Nullable
default Number getExpirationDays()

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

See Also:

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

getFields

@Stability(Stable)
@Nullable
default Object getFields()

A list of field definitions for the object type mapping.

See Also:

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

getKeys

@Stability(Stable)
@Nullable
default Object getKeys()

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

See Also:

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

getSourceLastUpdatedTimestampFormat

@Stability(Stable)
@Nullable
default String getSourceLastUpdatedTimestampFormat()

The format of your sourceLastUpdatedTimestamp that was previously set up.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getTemplateId

@Stability(Stable)
@Nullable
default String getTemplateId()

A unique identifier for the template mapping.

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

See Also:

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

builder

@Stability(Stable)
static CfnObjectTypeProps.Builder builder()

Returns:

a CfnObjectTypeProps.Builder of CfnObjectTypeProps