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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.075Z")
@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()
         .domainName("domainName")
         // the properties below are optional
         .allowProfileCreation(false)
         .description("description")
         .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()))
         .objectTypeName("objectTypeName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateId("templateId")
         .build();
 

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.
default 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.
default String	getObjectTypeName()	The name of the profile object type.
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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The unique name of the domain.

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.

getDescription

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

The description of the profile object type mapping.

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.

getExpirationDays

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

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

getFields

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

A list of field definitions for the object type mapping.

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.

getObjectTypeName

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

The name of the profile object type.

getTags

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

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

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.

builder

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

Returns:

a CfnObjectTypeProps.Builder of CfnObjectTypeProps