Class CfnObjectType
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnObjectType
.static interface
A map of the name and ObjectType field.static interface
A unique key map that can be used to map data to the profile.static interface
Represents a field in a ProfileObjectType.static interface
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.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnObjectType
(Construct scope, String id, CfnObjectTypeProps props) Create a newAWS::CustomerProfiles::ObjectType
.protected
CfnObjectType
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnObjectType
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionIndicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.The timestamp of when the object type was created.The timestamp of when the object type was most recently edited.The description of the profile object type mapping.The unique name of the domain.The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.The number of days until the data of this type expires.A list of field definitions for the object type mapping.getKeys()
A list of keys that can be used to map data to the profile or search for the profile.The name of the profile object type.getTags()
The tags used to organize, track, or control access for this resource.A unique identifier for the template mapping.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
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
A list of field definitions for the object type mapping.void
setFields
(IResolvable value) A list of field definitions for the object type mapping.void
A list of keys that can be used to map data to the profile or search for the profile.void
setKeys
(IResolvable 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.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 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnObjectType
protected CfnObjectType(software.amazon.jsii.JsiiObjectRef objRef) -
CfnObjectType
protected CfnObjectType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnObjectType
@Stability(Stable) public CfnObjectType(@NotNull Construct scope, @NotNull String id, @NotNull CfnObjectTypeProps props) Create a newAWS::CustomerProfiles::ObjectType
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The timestamp of when the object type was created. -
getAttrLastUpdatedAt
The timestamp of when the object type was most recently edited. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
The tags used to organize, track, or control access for this resource. -
getDomainName
The unique name of the domain. -
setDomainName
The unique name of the domain. -
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 toFALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE
, and if no match is found, then the service creates a new standard profile. -
setAllowProfileCreation
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 toFALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE
, and if no match is found, then the service creates a new standard profile. -
setAllowProfileCreation
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 toFALSE
, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE
, and if no match is found, then the service creates a new standard profile. -
getDescription
The description of the profile object type mapping. -
setDescription
The description of the profile object type mapping. -
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
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
The number of days until the data of this type expires. -
setExpirationDays
The number of days until the data of this type expires. -
getFields
A list of field definitions for the object type mapping. -
setFields
A list of field definitions for the object type mapping. -
setFields
A list of field definitions for the object type mapping. -
getKeys
A list of keys that can be used to map data to the profile or search for the profile. -
setKeys
A list of keys that can be used to map data to the profile or search for the profile. -
setKeys
A list of keys that can be used to map data to the profile or search for the profile. -
getObjectTypeName
The name of the profile object type. -
setObjectTypeName
The name of the profile object type. -
getTemplateId
A unique identifier for the template mapping.This can be used instead of specifying the Keys and Fields properties directly.
-
setTemplateId
A unique identifier for the template mapping.This can be used instead of specifying the Keys and Fields properties directly.
-