software.amazon.awscdk.services.customerprofiles

Class CfnObjectType

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.customerprofiles.CfnObjectType

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:32.582Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnObjectType(Construct scope, java.lang.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
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.
java.lang.String	getAttrCreatedAt() The timestamp of when the object type was created.
java.lang.String	getAttrLastUpdatedAt() The timestamp of when the object type was most recently edited.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the profile object type mapping.
java.lang.String	getDomainName() The unique name of the domain.
java.lang.String	getEncryptionKey() The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
java.lang.Number	getExpirationDays() The number of days until the data of this type expires.
java.lang.Object	getFields() A list of field definitions for the object type mapping.
java.lang.Object	getKeys() A list of keys that can be used to map data to the profile or search for the profile.
java.lang.String	getObjectTypeName() The name of the profile object type.
TagManager	getTags() The tags used to organize, track, or control access for this resource.
java.lang.String	getTemplateId() A unique identifier for the template mapping.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAllowProfileCreation(java.lang.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(java.lang.String value) The description of the profile object type mapping.
void	setDomainName(java.lang.String value) The unique name of the domain.
void	setEncryptionKey(java.lang.String value) The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
void	setExpirationDays(java.lang.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(java.util.List<java.lang.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(java.util.List<java.lang.Object> value) A list of keys that can be used to map data to the profile or search for the profile.
void	setObjectTypeName(java.lang.String value) The name of the profile object type.
void	setTemplateId(java.lang.String value) A unique identifier for the template mapping.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnObjectType(Construct scope,
                     java.lang.String id,
                     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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

public java.lang.String getAttrCreatedAt()

The timestamp of when the object type was created.

getAttrLastUpdatedAt

public java.lang.String getAttrLastUpdatedAt()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getDomainName

public java.lang.String getDomainName()

The unique name of the domain.

setDomainName

public void setDomainName(java.lang.String value)

The unique name of the domain.

getAllowProfileCreation

public 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.

setAllowProfileCreation

public void setAllowProfileCreation(java.lang.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

public 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.

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

public java.lang.String getDescription()

The description of the profile object type mapping.

setDescription

public void setDescription(java.lang.String value)

The description of the profile object type mapping.

getEncryptionKey

public 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.

setEncryptionKey

public void setEncryptionKey(java.lang.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

public java.lang.Number getExpirationDays()

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

setExpirationDays

public void setExpirationDays(java.lang.Number value)

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

getFields

public java.lang.Object getFields()

A list of field definitions for the object type mapping.

setFields

public void setFields(IResolvable value)

A list of field definitions for the object type mapping.

setFields

public void setFields(java.util.List<java.lang.Object> value)

A list of field definitions for the object type mapping.

getKeys

public java.lang.Object getKeys()

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

setKeys

public void setKeys(IResolvable value)

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

setKeys

public void setKeys(java.util.List<java.lang.Object> value)

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

getObjectTypeName

public java.lang.String getObjectTypeName()

The name of the profile object type.

setObjectTypeName

public void setObjectTypeName(java.lang.String value)

The name of the profile object type.

getTemplateId

public java.lang.String getTemplateId()

A unique identifier for the template mapping.

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

setTemplateId

public void setTemplateId(java.lang.String value)

A unique identifier for the template mapping.

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