software.amazon.awscdk.services.customerprofiles

Interface CfnObjectTypeProps

All Known Implementing Classes:

CfnObjectTypeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.362Z")
public interface CfnObjectTypeProps

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 and Description
static class	CfnObjectTypeProps.Builder A builder for CfnObjectTypeProps
static class	CfnObjectTypeProps.Jsii$Proxy An implementation for CfnObjectTypeProps

Method Summary

Modifier and Type	Method and Description
static CfnObjectTypeProps.Builder	builder()
default java.lang.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 java.lang.String	getDescription() The description of the profile object type mapping.
java.lang.String	getDomainName() The unique name of the domain.
default java.lang.String	getEncryptionKey() The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
default java.lang.Number	getExpirationDays() The number of days until the data of this type expires.
default java.lang.Object	getFields() A list of field definitions for the object type mapping.
default java.lang.Object	getKeys() A list of keys that can be used to map data to the profile or search for the profile.
default java.lang.String	getObjectTypeName() The name of the profile object type.
default java.util.List<CfnTag>	getTags() The tags used to organize, track, or control access for this resource.
default java.lang.String	getTemplateId() A unique identifier for the template mapping.

Method Detail

getDomainName

java.lang.String getDomainName()

The unique name of the domain.

getAllowProfileCreation

default java.lang.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

default java.lang.String getDescription()

The description of the profile object type mapping.

getEncryptionKey

default java.lang.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

default java.lang.Number getExpirationDays()

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

getFields

default java.lang.Object getFields()

A list of field definitions for the object type mapping.

getKeys

default java.lang.Object getKeys()

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

getObjectTypeName

default java.lang.String getObjectTypeName()

The name of the profile object type.

getTags

default java.util.List<CfnTag> getTags()

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

getTemplateId

default java.lang.String getTemplateId()

A unique identifier for the template mapping.

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

builder

static CfnObjectTypeProps.Builder builder()

Returns:

a CfnObjectTypeProps.Builder of CfnObjectTypeProps