software.amazon.awscdk.services.customerprofiles

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(value=Stable)
public static final class CfnObjectType.Builder
extends Object
implements software.amazon.jsii.Builder<CfnObjectType>

A fluent builder for CfnObjectType.

Method Summary

Modifier and Type	Method and Description
CfnObjectType.Builder	allowProfileCreation(Boolean allowProfileCreation) Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
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.
CfnObjectType	build()
static CfnObjectType.Builder	create(software.constructs.Construct scope, String id)
CfnObjectType.Builder	description(String description) The description of the profile object type mapping.
CfnObjectType.Builder	domainName(String domainName) The unique name of the domain.
CfnObjectType.Builder	encryptionKey(String encryptionKey) The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
CfnObjectType.Builder	expirationDays(Number expirationDays) The number of days until the data of this type expires.
CfnObjectType.Builder	fields(IResolvable fields) A list of field definitions for the object type mapping.
CfnObjectType.Builder	fields(List<? extends Object> fields) A list of field definitions for the object type mapping.
CfnObjectType.Builder	keys(IResolvable keys) A list of keys that can be used to map data to the profile or search for the profile.
CfnObjectType.Builder	keys(List<? extends Object> keys) A list of keys that can be used to map data to the profile or search for the profile.
CfnObjectType.Builder	objectTypeName(String objectTypeName) The name of the profile object type.
CfnObjectType.Builder	tags(List<? extends CfnTag> tags) The tags used to organize, track, or control access for this resource.
CfnObjectType.Builder	templateId(String templateId) A unique identifier for the template mapping.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnObjectType.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnObjectType.FieldMapProperty.Builder.

domainName

@Stability(value=Stable)
public CfnObjectType.Builder domainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain. This parameter is required.

Returns:

this

allowProfileCreation

@Stability(value=Stable)
public CfnObjectType.Builder allowProfileCreation(Boolean 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 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.

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(value=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 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.

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

@Stability(value=Stable)
public CfnObjectType.Builder description(String 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

@Stability(value=Stable)
public CfnObjectType.Builder encryptionKey(String 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

@Stability(value=Stable)
public CfnObjectType.Builder expirationDays(Number 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

@Stability(value=Stable)
public CfnObjectType.Builder fields(IResolvable 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

@Stability(value=Stable)
public CfnObjectType.Builder fields(List<? extends Object> 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

@Stability(value=Stable)
public CfnObjectType.Builder keys(IResolvable 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

@Stability(value=Stable)
public CfnObjectType.Builder keys(List<? extends Object> 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

@Stability(value=Stable)
public CfnObjectType.Builder objectTypeName(String objectTypeName)

The name of the profile object type.

Parameters:

objectTypeName - The name of the profile object type. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnObjectType.Builder tags(List<? extends CfnTag> 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

@Stability(value=Stable)
public CfnObjectType.Builder templateId(String 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

@Stability(value=Stable)
public CfnObjectType build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnObjectType>