software.amazon.awscdk.services.customerprofiles

Class CfnObjectType

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.customerprofiles.CfnObjectType

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.809Z")
 @Stability(value=Stable)
public class CfnObjectType
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CustomerProfiles::ObjectType`.

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

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.*;
 CfnObjectType cfnObjectType = CfnObjectType.Builder.create(this, "MyCfnObjectType")
         .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	Class and Description
static class	CfnObjectType.Builder A fluent builder for CfnObjectType.
static interface	CfnObjectType.FieldMapProperty A map of the name and ObjectType field.
static interface	CfnObjectType.KeyMapProperty A unique key map that can be used to map data to the profile.
static interface	CfnObjectType.ObjectTypeFieldProperty Represents a field in a ProfileObjectType.
static interface	CfnObjectType.ObjectTypeKeyProperty An object that defines the Key element of a ProfileObject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnObjectType(software.constructs.Construct scope, String id, CfnObjectTypeProps props) Create a new `AWS::CustomerProfiles::ObjectType`.
protected	CfnObjectType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnObjectType(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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	getAttrCreatedAt() The timestamp of when the object type was created.
String	getAttrLastUpdatedAt() The timestamp of when the object type was most recently edited.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the profile object type mapping.
String	getDomainName() The unique name of the domain.
String	getEncryptionKey() The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
Number	getExpirationDays() The number of days until the data of this type expires.
Object	getFields() A list of field definitions for the object type mapping.
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.
TagManager	getTags() The tags used to organize, track, or control access for this resource.
String	getTemplateId() A unique identifier for the template mapping.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowProfileCreation(Boolean value) Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
void	setAllowProfileCreation(IResolvable value) Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
void	setDescription(String value) The description of the profile object type mapping.
void	setDomainName(String value) The unique name of the domain.
void	setEncryptionKey(String value) The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
void	setExpirationDays(Number value) The number of days until the data of this type expires.
void	setFields(IResolvable value) A list of field definitions for the object type mapping.
void	setFields(List<Object> value) A list of field definitions for the object type mapping.
void	setKeys(IResolvable value) A list of keys that can be used to map data to the profile or search for the profile.
void	setKeys(List<Object> value) A list of keys that can be used to map data to the profile or search for the profile.
void	setObjectTypeName(String value) The name of the profile object type.
void	setTemplateId(String value) A unique identifier for the template mapping.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnObjectType

protected CfnObjectType(software.amazon.jsii.JsiiObjectRef objRef)

CfnObjectType

protected CfnObjectType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnObjectType

@Stability(value=Stable)
public CfnObjectType(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnObjectTypeProps props)

Create a new `AWS::CustomerProfiles::ObjectType`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The timestamp of when the object type was created.

getAttrLastUpdatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedAt()

The timestamp of when the object type was most recently edited.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDomainName

@Stability(value=Stable)
 @NotNull
public String getDomainName()

The unique name of the domain.

setDomainName

@Stability(value=Stable)
public void setDomainName(@NotNull
                                                   String value)

The unique name of the domain.

getAllowProfileCreation

@Stability(value=Stable)
 @Nullable
public 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.

setAllowProfileCreation

@Stability(value=Stable)
public void setAllowProfileCreation(@Nullable
                                                             Boolean value)

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.

setAllowProfileCreation

@Stability(value=Stable)
public void setAllowProfileCreation(@Nullable
                                                             IResolvable value)

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(value=Stable)
 @Nullable
public String getDescription()

The description of the profile object type mapping.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the profile object type mapping.

getEncryptionKey

@Stability(value=Stable)
 @Nullable
public 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.

setEncryptionKey

@Stability(value=Stable)
public void setEncryptionKey(@Nullable
                                                      String value)

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(value=Stable)
 @Nullable
public Number getExpirationDays()

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

setExpirationDays

@Stability(value=Stable)
public void setExpirationDays(@Nullable
                                                       Number value)

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

getFields

@Stability(value=Stable)
 @Nullable
public Object getFields()

A list of field definitions for the object type mapping.

setFields

@Stability(value=Stable)
public void setFields(@Nullable
                                               IResolvable value)

A list of field definitions for the object type mapping.

setFields

@Stability(value=Stable)
public void setFields(@Nullable
                                               List<Object> value)

A list of field definitions for the object type mapping.

getKeys

@Stability(value=Stable)
 @Nullable
public Object getKeys()

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

setKeys

@Stability(value=Stable)
public void setKeys(@Nullable
                                             IResolvable value)

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

setKeys

@Stability(value=Stable)
public void setKeys(@Nullable
                                             List<Object> value)

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

getObjectTypeName

@Stability(value=Stable)
 @Nullable
public String getObjectTypeName()

The name of the profile object type.

setObjectTypeName

@Stability(value=Stable)
public void setObjectTypeName(@Nullable
                                                       String value)

The name of the profile object type.

getTemplateId

@Stability(value=Stable)
 @Nullable
public String getTemplateId()

A unique identifier for the template mapping.

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

setTemplateId

@Stability(value=Stable)
public void setTemplateId(@Nullable
                                                   String value)

A unique identifier for the template mapping.

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