Package software.amazon.awscdk.services.entityresolution

Class CfnSchemaMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.entityresolution.CfnSchemaMapping
All Implemented Interfaces:
IInspectable, ISchemaMappingRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:21.109Z") @Stability(Stable) public class CfnSchemaMapping extends CfnResource implements IInspectable, ISchemaMappingRef, ITaggableV2
Creates a schema mapping, which defines the schema of the input customer records table.

The SchemaMapping also provides AWS Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

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.*;
 CfnSchemaMapping cfnSchemaMapping = CfnSchemaMapping.Builder.create(this, "MyCfnSchemaMapping")
         .mappedInputFields(List.of(SchemaInputAttributeProperty.builder()
                 .fieldName("fieldName")
                 .type("type")
                 // the properties below are optional
                 .groupName("groupName")
                 .hashed(false)
                 .matchKey("matchKey")
                 .subType("subType")
                 .build()))
         .schemaName("schemaName")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchemaMapping

      protected CfnSchemaMapping(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSchemaMapping

      protected CfnSchemaMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSchemaMapping

      @Stability(Stable) public CfnSchemaMapping(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSchemaMappingProps props)
      Create a new AWS::EntityResolution::SchemaMapping.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSchemaMapping

      @Stability(Stable) @NotNull public static String arnForSchemaMapping(@NotNull ISchemaMappingRef resource)
      Parameters:
      resource - This parameter is required.

    • fromSchemaName

      @Stability(Stable) @NotNull public static ISchemaMappingRef fromSchemaName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String schemaName)
      Creates a new ISchemaMappingRef from a schemaName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      schemaName - This parameter is required.

    • isCfnSchemaMapping

      @Stability(Stable) @NotNull public static Boolean isCfnSchemaMapping(@NotNull Object x)
      Checks whether the given object is a CfnSchemaMapping.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time of this SchemaMapping got created.

    • getAttrHasWorkflows

      @Stability(Stable) @NotNull public IResolvable getAttrHasWorkflows()
      The boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with.

    • getAttrSchemaArn

      @Stability(Stable) @NotNull public String getAttrSchemaArn()
      The SchemaMapping arn associated with the Schema.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time of this SchemaMapping got last updated at.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSchemaMappingRef

      @Stability(Stable) @NotNull public SchemaMappingReference getSchemaMappingRef()
      A reference to a SchemaMapping resource.
      Specified by:
      getSchemaMappingRef in interface ISchemaMappingRef

    • getMappedInputFields

      @Stability(Stable) @NotNull public Object getMappedInputFields()
      A list of MappedInputFields .

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSchemaMapping.SchemaInputAttributeProperty>

    • setMappedInputFields

      @Stability(Stable) public void setMappedInputFields(@NotNull IResolvable value)
      A list of MappedInputFields .

    • setMappedInputFields

      @Stability(Stable) public void setMappedInputFields(@NotNull List<Object> value)
      A list of MappedInputFields .

    • getSchemaName

      @Stability(Stable) @NotNull public String getSchemaName()
      The name of the schema.

    • setSchemaName

      @Stability(Stable) public void setSchemaName(@NotNull String value)
      The name of the schema.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the schema.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the schema.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.