CfnObjectType
- class aws_cdk.aws_customerprofiles.CfnObjectType(scope, id, *, description, domain_name, object_type_name, allow_profile_creation=None, encryption_key=None, expiration_days=None, fields=None, keys=None, source_last_updated_timestamp_format=None, tags=None, template_id=None)
Bases:
CfnResource
Specifies an Amazon Connect Customer Profiles Object Type Mapping.
- See:
- CloudformationResource:
AWS::CustomerProfiles::ObjectType
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_customerprofiles as customerprofiles cfn_object_type = customerprofiles.CfnObjectType(self, "MyCfnObjectType", description="description", domain_name="domainName", object_type_name="objectTypeName", # the properties below are optional allow_profile_creation=False, encryption_key="encryptionKey", expiration_days=123, fields=[customerprofiles.CfnObjectType.FieldMapProperty( name="name", object_type_field=customerprofiles.CfnObjectType.ObjectTypeFieldProperty( content_type="contentType", source="source", target="target" ) )], keys=[customerprofiles.CfnObjectType.KeyMapProperty( name="name", object_type_key_list=[customerprofiles.CfnObjectType.ObjectTypeKeyProperty( field_names=["fieldNames"], standard_identifiers=["standardIdentifiers"] )] )], source_last_updated_timestamp_format="sourceLastUpdatedTimestampFormat", tags=[CfnTag( key="key", value="value" )], template_id="templateId" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).description (
str
) – The description of the profile object type mapping.domain_name (
str
) – The unique name of the domain.object_type_name (
str
) – The name of the profile object type.allow_profile_creation (
Union
[bool
,IResolvable
,None
]) – Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default isFALSE
. 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.encryption_key (
Optional
[str
]) – 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.expiration_days (
Union
[int
,float
,None
]) – The number of days until the data of this type expires.fields (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FieldMapProperty
,Dict
[str
,Any
]]],None
]) – A list of field definitions for the object type mapping.keys (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,KeyMapProperty
,Dict
[str
,Any
]]],None
]) – A list of keys that can be used to map data to the profile or search for the profile.source_last_updated_timestamp_format (
Optional
[str
]) – The format of your sourceLastUpdatedTimestamp that was previously set up.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags used to organize, track, or control access for this resource.template_id (
Optional
[str
]) – A unique identifier for the template mapping. This can be used instead of specifying the Keys and Fields properties directly.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CustomerProfiles::ObjectType'
- allow_profile_creation
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
- attr_created_at
The timestamp of when the object type was created.
- CloudformationAttribute:
CreatedAt
- attr_last_updated_at
The timestamp of when the object type was most recently edited.
- CloudformationAttribute:
LastUpdatedAt
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of the profile object type mapping.
- domain_name
The unique name of the domain.
- encryption_key
The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
- expiration_days
The number of days until the data of this type expires.
- fields
A list of field definitions for the object type mapping.
- keys
A list of keys that can be used to map data to the profile or search for the profile.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- object_type_name
The name of the profile object type.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- source_last_updated_timestamp_format
The format of your sourceLastUpdatedTimestamp that was previously set up.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
The tags used to organize, track, or control access for this resource.
- template_id
A unique identifier for the template mapping.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
FieldMapProperty
- class CfnObjectType.FieldMapProperty(*, name=None, object_type_field=None)
Bases:
object
A map of the name and ObjectType field.
- Parameters:
name (
Optional
[str
]) – Name of the field.object_type_field (
Union
[IResolvable
,ObjectTypeFieldProperty
,Dict
[str
,Any
],None
]) – Represents a field in a ProfileObjectType.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_customerprofiles as customerprofiles field_map_property = customerprofiles.CfnObjectType.FieldMapProperty( name="name", object_type_field=customerprofiles.CfnObjectType.ObjectTypeFieldProperty( content_type="contentType", source="source", target="target" ) )
Attributes
- name
Name of the field.
- object_type_field
Represents a field in a ProfileObjectType.
KeyMapProperty
- class CfnObjectType.KeyMapProperty(*, name=None, object_type_key_list=None)
Bases:
object
A unique key map that can be used to map data to the profile.
- Parameters:
name (
Optional
[str
]) – Name of the key.object_type_key_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ObjectTypeKeyProperty
,Dict
[str
,Any
]]],None
]) – A list of ObjectTypeKey.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_customerprofiles as customerprofiles key_map_property = customerprofiles.CfnObjectType.KeyMapProperty( name="name", object_type_key_list=[customerprofiles.CfnObjectType.ObjectTypeKeyProperty( field_names=["fieldNames"], standard_identifiers=["standardIdentifiers"] )] )
Attributes
- name
Name of the key.
- object_type_key_list
A list of ObjectTypeKey.
ObjectTypeFieldProperty
- class CfnObjectType.ObjectTypeFieldProperty(*, content_type=None, source=None, target=None)
Bases:
object
Represents a field in a ProfileObjectType.
- Parameters:
content_type (
Optional
[str
]) – The content type of the field. Used for determining equality when searching.source (
Optional
[str
]) – A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.target (
Optional
[str
]) – The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_customerprofiles as customerprofiles object_type_field_property = customerprofiles.CfnObjectType.ObjectTypeFieldProperty( content_type="contentType", source="source", target="target" )
Attributes
- content_type
The content type of the field.
Used for determining equality when searching.
- source
A field of a ProfileObject.
For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
- target
The location of the data in the standard ProfileObject model.
For example: _profile.Address.PostalCode.
ObjectTypeKeyProperty
- class CfnObjectType.ObjectTypeKeyProperty(*, field_names=None, standard_identifiers=None)
Bases:
object
An object that defines the Key element of a ProfileObject.
A Key is a special element that can be used to search for a customer profile.
- Parameters:
field_names (
Optional
[Sequence
[str
]]) – The reference for the key name of the fields map.standard_identifiers (
Optional
[Sequence
[str
]]) – The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_customerprofiles as customerprofiles object_type_key_property = customerprofiles.CfnObjectType.ObjectTypeKeyProperty( field_names=["fieldNames"], standard_identifiers=["standardIdentifiers"] )
Attributes
- field_names
The reference for the key name of the fields map.
- standard_identifiers
The types of keys that a ProfileObject can have.
Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.