Class CfnObjectType.Builder
java.lang.Object
software.amazon.awscdk.services.customerprofiles.CfnObjectType.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnObjectType>
- Enclosing class:
CfnObjectType
@Stability(Stable)
public static final class CfnObjectType.Builder
extends Object
implements software.amazon.jsii.Builder<CfnObjectType>
A fluent builder for
CfnObjectType
.-
Method Summary
Modifier and TypeMethodDescriptionallowProfileCreation
(Boolean allowProfileCreation) Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.allowProfileCreation
(IResolvable allowProfileCreation) Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.build()
static CfnObjectType.Builder
description
(String description) The description of the profile object type mapping.domainName
(String domainName) The unique name of the domain.encryptionKey
(String encryptionKey) The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.expirationDays
(Number expirationDays) The number of days until the data of this type expires.A list of field definitions for the object type mapping.fields
(IResolvable fields) A list of field definitions for the object type mapping.A list of keys that can be used to map data to the profile or search for the profile.keys
(IResolvable keys) A list of keys that can be used to map data to the profile or search for the profile.objectTypeName
(String objectTypeName) The name of the profile object type.The tags used to organize, track, or control access for this resource.templateId
(String templateId) A unique identifier for the template mapping.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnObjectType.Builder
.
-
domainName
The unique name of the domain.- Parameters:
domainName
- The unique name of the domain. This parameter is required.- Returns:
this
-
allowProfileCreation
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.- Parameters:
allowProfileCreation
- Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. This parameter is required.- Returns:
this
-
allowProfileCreation
@Stability(Stable) public CfnObjectType.Builder allowProfileCreation(IResolvable allowProfileCreation) 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.- Parameters:
allowProfileCreation
- Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. This parameter is required.- Returns:
this
-
description
The description of the profile object type mapping.- Parameters:
description
- The description of the profile object type mapping. This parameter is required.- Returns:
this
-
encryptionKey
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.
- Parameters:
encryptionKey
- The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. This parameter is required.- Returns:
this
-
expirationDays
The number of days until the data of this type expires.- Parameters:
expirationDays
- The number of days until the data of this type expires. This parameter is required.- Returns:
this
-
fields
A list of field definitions for the object type mapping.- Parameters:
fields
- A list of field definitions for the object type mapping. This parameter is required.- Returns:
this
-
fields
A list of field definitions for the object type mapping.- Parameters:
fields
- A list of field definitions for the object type mapping. This parameter is required.- Returns:
this
-
keys
A list of keys that can be used to map data to the profile or search for the profile.- Parameters:
keys
- A list of keys that can be used to map data to the profile or search for the profile. This parameter is required.- Returns:
this
-
keys
A list of keys that can be used to map data to the profile or search for the profile.- Parameters:
keys
- A list of keys that can be used to map data to the profile or search for the profile. This parameter is required.- Returns:
this
-
objectTypeName
The name of the profile object type.- Parameters:
objectTypeName
- The name of the profile object type. This parameter is required.- Returns:
this
-
tags
The tags used to organize, track, or control access for this resource.- Parameters:
tags
- The tags used to organize, track, or control access for this resource. This parameter is required.- Returns:
this
-
templateId
A unique identifier for the template mapping.This can be used instead of specifying the Keys and Fields properties directly.
- Parameters:
templateId
- A unique identifier for the template mapping. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnObjectType>
- Returns:
- a newly built instance of
CfnObjectType
.
-