Package software.amazon.awscdk.services.entityresolution

Interface CfnSchemaMappingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchemaMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:59.649Z")
@Stability(Stable)
public interface CfnSchemaMappingProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSchemaMapping.

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.*;
 CfnSchemaMappingProps cfnSchemaMappingProps = CfnSchemaMappingProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSchemaMappingProps.Builder	builder()
default String	getDescription()	A description of the schema.
Object	getMappedInputFields()	A list of MappedInputFields .
String	getSchemaName()	The name of the schema.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMappedInputFields

@Stability(Stable)
@NotNull
Object getMappedInputFields()

A list of MappedInputFields .

Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that AWS Entity Resolution uses for matching.

See Also:

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

getSchemaName

@Stability(Stable)
@NotNull
String getSchemaName()

The name of the schema.

There can't be multiple SchemaMappings with the same name.

See Also:

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

getDescription

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

A description of the schema.

See Also:

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

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-schemamapping.html#cfn-entityresolution-schemamapping-tags

builder

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

Returns:

a CfnSchemaMappingProps.Builder of CfnSchemaMappingProps