Class: AWSCDK::EntityResolution::CfnIdNamespaceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
entity_resolution/cfn_id_namespace_props.rb

Overview

Properties for defining a CfnIdNamespace.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id_namespace_name:, type:, description: nil, id_mapping_workflow_properties: nil, input_source_config: nil, role_arn: nil, tags: nil) ⇒ CfnIdNamespaceProps

Returns a new instance of CfnIdNamespaceProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 16

def initialize(id_namespace_name:, type:, description: nil, id_mapping_workflow_properties: nil, input_source_config: nil, role_arn: nil, tags: nil)
  @id_namespace_name = id_namespace_name
  Jsii::Type.check_type(@id_namespace_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "idNamespaceName")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @id_mapping_workflow_properties = id_mapping_workflow_properties
  Jsii::Type.check_type(@id_mapping_workflow_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZW50aXR5cmVzb2x1dGlvbi5DZm5JZE5hbWVzcGFjZS5JZE5hbWVzcGFjZUlkTWFwcGluZ1dvcmtmbG93UHJvcGVydGllc1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "idMappingWorkflowProperties") unless @id_mapping_workflow_properties.nil?
  @input_source_config = input_source_config
  Jsii::Type.check_type(@input_source_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZW50aXR5cmVzb2x1dGlvbi5DZm5JZE5hbWVzcGFjZS5JZE5hbWVzcGFjZUlucHV0U291cmNlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inputSourceConfig") unless @input_source_config.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the ID namespace.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 51

def description
  @description
end

#id_mapping_workflow_properties ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



56
57
58
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 56

def id_mapping_workflow_properties
  @id_mapping_workflow_properties
end

#id_namespace_name ⇒ String (readonly)

The name of the ID namespace.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 37

def id_namespace_name
  @id_namespace_name
end

#input_source_config ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



61
62
63
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 61

def input_source_config
  @input_source_config
end

#role_arn ⇒ String? (readonly)

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

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

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 68

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



73
74
75
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 73

def tags
  @tags
end

#type ⇒ String (readonly)

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

The SOURCE contains configurations for source_id data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of target_id which all source_ids will resolve to.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 46

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 75

def self.jsii_properties
  {
    :id_namespace_name => "idNamespaceName",
    :type => "type",
    :description => "description",
    :id_mapping_workflow_properties => "idMappingWorkflowProperties",
    :input_source_config => "inputSourceConfig",
    :role_arn => "roleArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'entity_resolution/cfn_id_namespace_props.rb', line 87

def to_jsii
  result = {}
  result.merge!({
    "idNamespaceName" => @id_namespace_name,
    "type" => @type,
    "description" => @description,
    "idMappingWorkflowProperties" => @id_mapping_workflow_properties,
    "inputSourceConfig" => @input_source_config,
    "roleArn" => @role_arn,
    "tags" => @tags,
  })
  result.compact
end