@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:49.901Z") public class CfnObjectType extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnObjectType(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnObjectType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnObjectType(Construct scope, java.lang.String id, CfnObjectTypeProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrCreatedAt()
public java.lang.String getAttrLastUpdatedAt()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getDomainName()
public void setDomainName(java.lang.String value)
public java.lang.Object getAllowProfileCreation()
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.
public void setAllowProfileCreation(java.lang.Boolean value)
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.
public void setAllowProfileCreation(IResolvable value)
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.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getEncryptionKey()
If not specified the system will use the encryption key of the domain.
public void setEncryptionKey(java.lang.String value)
If not specified the system will use the encryption key of the domain.
public java.lang.Number getExpirationDays()
public void setExpirationDays(java.lang.Number value)
public java.lang.Object getFields()
public void setFields(IResolvable value)
public void setFields(java.util.List<java.lang.Object> value)
public java.lang.Object getKeys()
public void setKeys(IResolvable value)
public void setKeys(java.util.List<java.lang.Object> value)
public java.lang.String getObjectTypeName()
public void setObjectTypeName(java.lang.String value)
public java.lang.String getTemplateId()
This can be used instead of specifying the Keys and Fields properties directly.
public void setTemplateId(java.lang.String value)
This can be used instead of specifying the Keys and Fields properties directly.