Package software.amazon.awscdk.services.entityresolution

Class CfnIdNamespace

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.CfnIdNamespace
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:59.634Z") @Stability(Stable) public class CfnIdNamespace extends CfnResource implements IInspectable, ITaggableV2
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.

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.*;
 CfnIdNamespace cfnIdNamespace = CfnIdNamespace.Builder.create(this, "MyCfnIdNamespace")
         .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:

  • 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

    • CfnIdNamespace

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

    • CfnIdNamespace

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

    • CfnIdNamespace

      @Stability(Stable) public CfnIdNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdNamespaceProps props)
      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

    • 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 date and time when the IdNamespace was created.

    • getAttrIdNamespaceArn

      @Stability(Stable) @NotNull public String getAttrIdNamespaceArn()
      The arn associated with the IdNamespace.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The date and time when the IdNamespace was updated.

    • 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

    • getIdNamespaceName

      @Stability(Stable) @NotNull public String getIdNamespaceName()
      The name of the ID namespace.

    • setIdNamespaceName

      @Stability(Stable) public void setIdNamespaceName(@NotNull String value)
      The name of the ID namespace.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of ID namespace.

      There are two types: SOURCE and TARGET .

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of ID namespace.

      There are two types: SOURCE and TARGET .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the ID namespace.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the ID namespace.

    • getIdMappingWorkflowProperties

      @Stability(Stable) @Nullable public Object getIdMappingWorkflowProperties()
      Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

    • setIdMappingWorkflowProperties

      @Stability(Stable) public void setIdMappingWorkflowProperties(@Nullable IResolvable value)
      Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

    • setIdMappingWorkflowProperties

      @Stability(Stable) public void setIdMappingWorkflowProperties(@Nullable List<Object> value)
      Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

    • getInputSourceConfig

      @Stability(Stable) @Nullable public Object getInputSourceConfig()
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

    • setInputSourceConfig

      @Stability(Stable) public void setInputSourceConfig(@Nullable IResolvable value)
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

    • setInputSourceConfig

      @Stability(Stable) public void setInputSourceConfig(@Nullable List<Object> value)
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM role.

    • 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.