CfnIdNamespace

class aws_cdk.aws_entityresolution.CfnIdNamespace(scope, id, *, id_namespace_name, type, description=None, id_mapping_workflow_properties=None, input_source_config=None, role_arn=None, tags=None)

Bases: CfnResource

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.

Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html

CloudformationResource:

AWS::EntityResolution::IdNamespace

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_entityresolution as entityresolution

cfn_id_namespace = entityresolution.CfnIdNamespace(self, "MyCfnIdNamespace",
    id_namespace_name="idNamespaceName",
    type="type",

    # the properties below are optional
    description="description",
    id_mapping_workflow_properties=[entityresolution.CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty(
        id_mapping_type="idMappingType",

        # the properties below are optional
        provider_properties=entityresolution.CfnIdNamespace.NamespaceProviderPropertiesProperty(
            provider_service_arn="providerServiceArn",

            # the properties below are optional
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            }
        ),
        rule_based_properties=entityresolution.CfnIdNamespace.NamespaceRuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            record_matching_models=["recordMatchingModels"],
            rule_definition_types=["ruleDefinitionTypes"],
            rules=[entityresolution.CfnIdNamespace.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )]
        )
    )],
    input_source_config=[entityresolution.CfnIdNamespace.IdNamespaceInputSourceProperty(
        input_source_arn="inputSourceArn",

        # the properties below are optional
        schema_name="schemaName"
    )],
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • id_namespace_name (str) – The name of the ID namespace.

  • type (str) – The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId which all sourceIds will resolve to.

  • description (Optional[str]) – The description of the ID namespace.

  • id_mapping_workflow_properties (Union[IResolvable, Sequence[Union[IResolvable, IdNamespaceIdMappingWorkflowPropertiesProperty, Dict[str, Any]]], None]) – Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

  • input_source_config (Union[IResolvable, Sequence[Union[IResolvable, IdNamespaceInputSourceProperty, Dict[str, Any]]], None]) – A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

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 prefix path 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 to addOverride 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: true

  • default (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:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

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:

Reference

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:
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::EntityResolution::IdNamespace'
attr_created_at

The date and time when the IdNamespace was created.

CloudformationAttribute:

CreatedAt

attr_id_namespace_arn

The arn associated with the IdNamespace.

CloudformationAttribute:

IdNamespaceArn

attr_updated_at

The date and time when the IdNamespace was updated.

CloudformationAttribute:

UpdatedAt

cdk_tag_manager

Tag Manager which manages the tags for this resource.

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 ID namespace.

id_mapping_workflow_properties

Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

id_namespace_name

The name of the ID namespace.

input_source_config

A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

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.

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 }).

role_arn

The Amazon Resource Name (ARN) of the IAM role.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

The tags used to organize, track, or control access for this resource.

type

The type of ID namespace.

There are two types: SOURCE and TARGET .

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 detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, 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 extends Construct.

IdNamespaceIdMappingWorkflowPropertiesProperty

class CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty(*, id_mapping_type, provider_properties=None, rule_based_properties=None)

Bases: object

An object containing IdMappingType , ProviderProperties , and RuleBasedProperties .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html

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_entityresolution as entityresolution

id_namespace_id_mapping_workflow_properties_property = entityresolution.CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty(
    id_mapping_type="idMappingType",

    # the properties below are optional
    provider_properties=entityresolution.CfnIdNamespace.NamespaceProviderPropertiesProperty(
        provider_service_arn="providerServiceArn",

        # the properties below are optional
        provider_configuration={
            "provider_configuration_key": "providerConfiguration"
        }
    ),
    rule_based_properties=entityresolution.CfnIdNamespace.NamespaceRuleBasedPropertiesProperty(
        attribute_matching_model="attributeMatchingModel",
        record_matching_models=["recordMatchingModels"],
        rule_definition_types=["ruleDefinitionTypes"],
        rules=[entityresolution.CfnIdNamespace.RuleProperty(
            matching_keys=["matchingKeys"],
            rule_name="ruleName"
        )]
    )
)

Attributes

id_mapping_type

The type of ID mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-idmappingtype

provider_properties

An object which defines any additional configurations required by the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-providerproperties

rule_based_properties

An object which defines any additional configurations required by rule-based matching.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-rulebasedproperties

IdNamespaceInputSourceProperty

class CfnIdNamespace.IdNamespaceInputSourceProperty(*, input_source_arn, schema_name=None)

Bases: object

An object containing InputSourceARN and SchemaName .

Parameters:

  • input_source_arn (str) – An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

  • schema_name (Optional[str]) – The name of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html

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_entityresolution as entityresolution

id_namespace_input_source_property = entityresolution.CfnIdNamespace.IdNamespaceInputSourceProperty(
    input_source_arn="inputSourceArn",

    # the properties below are optional
    schema_name="schemaName"
)

Attributes

input_source_arn

An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-inputsourcearn

schema_name

The name of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-schemaname

NamespaceProviderPropertiesProperty

class CfnIdNamespace.NamespaceProviderPropertiesProperty(*, provider_service_arn, provider_configuration=None)

Bases: object

An object containing ProviderConfiguration and ProviderServiceArn .

Parameters:

  • provider_service_arn (str) – The Amazon Resource Name (ARN) of the provider service.

  • provider_configuration (Union[Mapping[str, str], IResolvable, None]) – An object which defines any additional configurations required by the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html

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_entityresolution as entityresolution

namespace_provider_properties_property = entityresolution.CfnIdNamespace.NamespaceProviderPropertiesProperty(
    provider_service_arn="providerServiceArn",

    # the properties below are optional
    provider_configuration={
        "provider_configuration_key": "providerConfiguration"
    }
)

Attributes

provider_configuration

An object which defines any additional configurations required by the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerconfiguration

provider_service_arn

The Amazon Resource Name (ARN) of the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerservicearn

NamespaceRuleBasedPropertiesProperty

class CfnIdNamespace.NamespaceRuleBasedPropertiesProperty(*, attribute_matching_model=None, record_matching_models=None, rule_definition_types=None, rules=None)

Bases: object

The rule-based properties of an ID namespace.

These properties define how the ID namespace can be used in an ID mapping workflow.

Parameters:

  • attribute_matching_model (Optional[str]) – The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel . If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type. If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

  • record_matching_models (Optional[Sequence[str]]) – The type of matching record that is allowed to be used in an ID mapping workflow. If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target. If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

  • rule_definition_types (Optional[Sequence[str]]) – The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

  • rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]], None]) – The rules for the ID namespace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html

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_entityresolution as entityresolution

namespace_rule_based_properties_property = entityresolution.CfnIdNamespace.NamespaceRuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    record_matching_models=["recordMatchingModels"],
    rule_definition_types=["ruleDefinitionTypes"],
    rules=[entityresolution.CfnIdNamespace.RuleProperty(
        matching_keys=["matchingKeys"],
        rule_name="ruleName"
    )]
)

Attributes

attribute_matching_model

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-attributematchingmodel

record_matching_models

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source is matched to one record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-recordmatchingmodels

rule_definition_types

The sets of rules you can use in an ID mapping workflow.

The limitations specified for the source and target must be compatible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-ruledefinitiontypes

rules

The rules for the ID namespace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-rules

RuleProperty

class CfnIdNamespace.RuleProperty(*, matching_keys, rule_name)

Bases: object

An object containing RuleName , and MatchingKeys .

Parameters:

  • matching_keys (Sequence[str]) – A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

  • rule_name (str) – A name for the matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html

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_entityresolution as entityresolution

rule_property = entityresolution.CfnIdNamespace.RuleProperty(
    matching_keys=["matchingKeys"],
    rule_name="ruleName"
)

Attributes

matching_keys

A list of MatchingKeys .

The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html#cfn-entityresolution-idnamespace-rule-matchingkeys

rule_name

A name for the matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-rule.html#cfn-entityresolution-idnamespace-rule-rulename