Class CfnIdNamespaceProps

Properties for defining a CfnIdNamespace.

Inheritance

object

CfnIdNamespaceProps

Implements

ICfnIdNamespaceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EntityResolution

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIdNamespaceProps : ICfnIdNamespaceProps

Syntax (vb)

Public Class CfnIdNamespaceProps Implements ICfnIdNamespaceProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EntityResolution;

             var cfnIdNamespaceProps = new CfnIdNamespaceProps {
                 IdNamespaceName = "idNamespaceName",
                 Type = "type",

                 // the properties below are optional
                 Description = "description",
                 IdMappingWorkflowProperties = new [] { new IdNamespaceIdMappingWorkflowPropertiesProperty {
                     IdMappingType = "idMappingType",

                     // the properties below are optional
                     ProviderProperties = new NamespaceProviderPropertiesProperty {
                         ProviderServiceArn = "providerServiceArn",

                         // the properties below are optional
                         ProviderConfiguration = new Dictionary<string, string> {
                             { "providerConfigurationKey", "providerConfiguration" }
                         }
                     },
                     RuleBasedProperties = new NamespaceRuleBasedPropertiesProperty {
                         AttributeMatchingModel = "attributeMatchingModel",
                         RecordMatchingModels = new [] { "recordMatchingModels" },
                         RuleDefinitionTypes = new [] { "ruleDefinitionTypes" },
                         Rules = new [] { new RuleProperty {
                             MatchingKeys = new [] { "matchingKeys" },
                             RuleName = "ruleName"
                         } }
                     }
                 } },
                 InputSourceConfig = new [] { new IdNamespaceInputSourceProperty {
                     InputSourceArn = "inputSourceArn",

                     // the properties below are optional
                     SchemaName = "schemaName"
                 } },
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnIdNamespaceProps()

Properties for defining a CfnIdNamespace.

Properties

Description	The description of the ID namespace.
IdMappingWorkflowProperties	Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .
IdNamespaceName	The name of the ID namespace.
InputSourceConfig	A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
RoleArn	The Amazon Resource Name (ARN) of the IAM role.
Tags	The tags used to organize, track, or control access for this resource.
Type	The type of ID namespace. There are two types: SOURCE and TARGET .

Constructors

CfnIdNamespaceProps()

Properties for defining a CfnIdNamespace.

public CfnIdNamespaceProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EntityResolution;

             var cfnIdNamespaceProps = new CfnIdNamespaceProps {
                 IdNamespaceName = "idNamespaceName",
                 Type = "type",

                 // the properties below are optional
                 Description = "description",
                 IdMappingWorkflowProperties = new [] { new IdNamespaceIdMappingWorkflowPropertiesProperty {
                     IdMappingType = "idMappingType",

                     // the properties below are optional
                     ProviderProperties = new NamespaceProviderPropertiesProperty {
                         ProviderServiceArn = "providerServiceArn",

                         // the properties below are optional
                         ProviderConfiguration = new Dictionary<string, string> {
                             { "providerConfigurationKey", "providerConfiguration" }
                         }
                     },
                     RuleBasedProperties = new NamespaceRuleBasedPropertiesProperty {
                         AttributeMatchingModel = "attributeMatchingModel",
                         RecordMatchingModels = new [] { "recordMatchingModels" },
                         RuleDefinitionTypes = new [] { "ruleDefinitionTypes" },
                         Rules = new [] { new RuleProperty {
                             MatchingKeys = new [] { "matchingKeys" },
                             RuleName = "ruleName"
                         } }
                     }
                 } },
                 InputSourceConfig = new [] { new IdNamespaceInputSourceProperty {
                     InputSourceArn = "inputSourceArn",

                     // the properties below are optional
                     SchemaName = "schemaName"
                 } },
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

The description of the ID namespace.

public string? Description { get; set; }

Property Value

string

Remarks

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

IdMappingWorkflowProperties

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

public object? IdMappingWorkflowProperties { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnIdNamespace.IIdNamespaceIdMappingWorkflowPropertiesProperty)[]

IdNamespaceName

The name of the ID namespace.

public string IdNamespaceName { get; set; }

Property Value

string

Remarks

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

InputSourceConfig

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

public object? InputSourceConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnIdNamespace.IIdNamespaceInputSourceProperty)[]

RoleArn

The Amazon Resource Name (ARN) of the IAM role.

public string? RoleArn { get; set; }

Property Value

string

Remarks

AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

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

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Type

The type of ID namespace. There are two types: SOURCE and TARGET .

public string Type { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-type

Implements

ICfnIdNamespaceProps