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-12-06T14:43:19.239Z")
@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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnIdNamespace
.static interface
An object containingIdMappingType
,ProviderProperties
, andRuleBasedProperties
.static interface
An object containingInputSourceARN
andSchemaName
.static interface
An object containingProviderConfiguration
andProviderServiceArn
.static interface
The rule-based properties of an ID namespace.static interface
An object containingRuleName
, andMatchingKeys
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnIdNamespace
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIdNamespace
(software.amazon.jsii.JsiiObjectRef objRef) CfnIdNamespace
(software.constructs.Construct scope, String id, CfnIdNamespaceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe date and time when the IdNamespace was created.The arn associated with the IdNamespace.The date and time when the IdNamespace was updated.Tag Manager which manages the tags for this resource.The description of the ID namespace.Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
.The name of the ID namespace.A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
.The Amazon Resource Name (ARN) of the IAM role.getTags()
The tags used to organize, track, or control access for this resource.getType()
The type of ID namespace.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the ID namespace.void
setIdMappingWorkflowProperties
(List<Object> value) Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
.void
Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
.void
setIdNamespaceName
(String value) The name of the ID namespace.void
setInputSourceConfig
(List<Object> value) A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
.void
setInputSourceConfig
(IResolvable value) A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role.void
The tags used to organize, track, or control access for this resource.void
The type of ID namespace.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The date and time when the IdNamespace was created. -
getAttrIdNamespaceArn
The arn associated with the IdNamespace. -
getAttrUpdatedAt
The date and time when the IdNamespace was updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getIdNamespaceName
The name of the ID namespace. -
setIdNamespaceName
The name of the ID namespace. -
getType
The type of ID namespace.There are two types:
SOURCE
andTARGET
. -
setType
The type of ID namespace.There are two types:
SOURCE
andTARGET
. -
getDescription
The description of the ID namespace. -
setDescription
The description of the ID namespace. -
getIdMappingWorkflowProperties
Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
. -
setIdMappingWorkflowProperties
Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
. -
setIdMappingWorkflowProperties
Determines the properties ofIdMappingWorflow
where thisIdNamespace
can be used as aSource
or aTarget
. -
getInputSourceConfig
A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
. -
setInputSourceConfig
A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
. -
setInputSourceConfig
A list ofInputSource
objects, which have the fieldsInputSourceARN
andSchemaName
. -
getRoleArn
The Amazon Resource Name (ARN) of the IAM role. -
setRoleArn
The Amazon Resource Name (ARN) of the IAM role. -
getTags
The tags used to organize, track, or control access for this resource. -
setTags
The tags used to organize, track, or control access for this resource.
-