Package software.amazon.awscdk.services.customerprofiles

Class CfnObjectType

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.072Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the object type was created.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the object type was most recently edited.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags used to organize, track, or control access for this resource.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The unique name of the domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The unique name of the domain.

    • getAllowProfileCreation

      @Stability(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(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(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(Stable) @Nullable public String getDescription()
      The description of the profile object type mapping.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the profile object type mapping.

    • getEncryptionKey

      @Stability(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(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(Stable) @Nullable public Number getExpirationDays()
      The number of days until the data of this type expires.

    • setExpirationDays

      @Stability(Stable) public void setExpirationDays(@Nullable Number value)
      The number of days until the data of this type expires.

    • getFields

      @Stability(Stable) @Nullable public Object getFields()
      A list of field definitions for the object type mapping.

    • setFields

      @Stability(Stable) public void setFields(@Nullable IResolvable value)
      A list of field definitions for the object type mapping.

    • setFields

      @Stability(Stable) public void setFields(@Nullable List<Object> value)
      A list of field definitions for the object type mapping.

    • getKeys

      @Stability(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(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(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(Stable) @Nullable public String getObjectTypeName()
      The name of the profile object type.

    • setObjectTypeName

      @Stability(Stable) public void setObjectTypeName(@Nullable String value)
      The name of the profile object type.

    • getTemplateId

      @Stability(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(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.