Package software.amazon.awscdk.services.entityresolution

Interface CfnIdNamespaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdNamespaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:59.124Z")
@Stability(Stable)
public interface CfnIdNamespaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIdNamespace.

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.entityresolution.*;
 CfnIdNamespaceProps cfnIdNamespaceProps = CfnIdNamespaceProps.builder()
         .idNamespaceName("idNamespaceName")
         .type("type")
         // the properties below are optional
         .description("description")
         .idMappingWorkflowProperties(List.of(IdNamespaceIdMappingWorkflowPropertiesProperty.builder()
                 .idMappingType("idMappingType")
                 // the properties below are optional
                 .providerProperties(NamespaceProviderPropertiesProperty.builder()
                         .providerServiceArn("providerServiceArn")
                         // the properties below are optional
                         .providerConfiguration(Map.of(
                                 "providerConfigurationKey", "providerConfiguration"))
                         .build())
                 .ruleBasedProperties(NamespaceRuleBasedPropertiesProperty.builder()
                         .attributeMatchingModel("attributeMatchingModel")
                         .recordMatchingModels(List.of("recordMatchingModels"))
                         .ruleDefinitionTypes(List.of("ruleDefinitionTypes"))
                         .rules(List.of(RuleProperty.builder()
                                 .matchingKeys(List.of("matchingKeys"))
                                 .ruleName("ruleName")
                                 .build()))
                         .build())
                 .build()))
         .inputSourceConfig(List.of(IdNamespaceInputSourceProperty.builder()
                 .inputSourceArn("inputSourceArn")
                 // the properties below are optional
                 .schemaName("schemaName")
                 .build()))
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdNamespaceProps.Builder	A builder for CfnIdNamespaceProps
static final class	CfnIdNamespaceProps.Jsii$Proxy	An implementation for CfnIdNamespaceProps

Method Summary

Modifier and Type	Method	Description
static CfnIdNamespaceProps.Builder	builder()
default String	getDescription()	The description of the ID namespace.
default Object	getIdMappingWorkflowProperties()	Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
String	getIdNamespaceName()	The name of the ID namespace.
default Object	getInputSourceConfig()	A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
String	getType()	The type of ID namespace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdNamespaceName

@Stability(Stable)
@NotNull
String getIdNamespaceName()

The name of the ID namespace.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

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.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the ID namespace.

See Also:

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

getIdMappingWorkflowProperties

@Stability(Stable)
@Nullable
default Object getIdMappingWorkflowProperties()

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

See Also:

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

getInputSourceConfig

@Stability(Stable)
@Nullable
default Object getInputSourceConfig()

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

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnIdNamespaceProps.Builder builder()

Returns:

a CfnIdNamespaceProps.Builder of CfnIdNamespaceProps