Class: AWSCDK::CleanRooms::CfnConfiguredTableAssociationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
clean_rooms/cfn_configured_table_association_props.rb

Overview

Properties for defining a CfnConfiguredTableAssociation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configured_table_identifier:, membership_identifier:, name:, role_arn:, configured_table_association_analysis_rules: nil, description: nil, tags: nil) ⇒ CfnConfiguredTableAssociationProps

Returns a new instance of CfnConfiguredTableAssociationProps.

Parameters:

  • configured_table_identifier (String) —

    A unique identifier for the configured table to be associated to.

  • membership_identifier (String) —

    The unique ID for the membership this configured table association belongs to.

  • name (String) —

    The name of the configured table association, in lowercase.

  • role_arn (String) —

    The service will assume this role to access catalog metadata and query the table.

  • configured_table_association_analysis_rules (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CleanRooms::CfnConfiguredTableAssociation::ConfiguredTableAssociationAnalysisRuleProperty>, nil) (defaults to: nil) —

    An analysis rule for a configured table association.

  • description (String, nil) (defaults to: nil) —

    A description of the configured table association.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An optional label that you can assign to a resource when you create it.



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

def initialize(configured_table_identifier:, membership_identifier:, name:, role_arn:, configured_table_association_analysis_rules: nil, description: nil, tags: nil)
  @configured_table_identifier = configured_table_identifier
  Jsii::Type.check_type(@configured_table_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configuredTableIdentifier")
  @membership_identifier = membership_identifier
  Jsii::Type.check_type(@membership_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "membershipIdentifier")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @configured_table_association_analysis_rules = configured_table_association_analysis_rules
  Jsii::Type.check_type(@configured_table_association_analysis_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5Db25maWd1cmVkVGFibGVBc3NvY2lhdGlvbi5Db25maWd1cmVkVGFibGVBc3NvY2lhdGlvbkFuYWx5c2lzUnVsZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "configuredTableAssociationAnalysisRules") unless @configured_table_association_analysis_rules.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.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

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

An analysis rule for a configured table association.

This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule .

Returns:

See Also:



63
64
65
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 63

def configured_table_association_analysis_rules
  @configured_table_association_analysis_rules
end

#configured_table_identifier ⇒ String (readonly)

A unique identifier for the configured table to be associated to.

Currently accepts a configured table ID.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 39

def configured_table_identifier
  @configured_table_identifier
end

#description ⇒ String? (readonly)

A description of the configured table association.

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 68

def description
  @description
end

#membership_identifier ⇒ String (readonly)

The unique ID for the membership this configured table association belongs to.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 44

def membership_identifier
  @membership_identifier
end

#name ⇒ String (readonly)

The name of the configured table association, in lowercase.

The table is identified by this name when running protected queries against the underlying data.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 51

def name
  @name
end

#role_arn ⇒ String (readonly)

The service will assume this role to access catalog metadata and query the table.

Returns:

  • (String)

See Also:



56
57
58
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 56

def role_arn
  @role_arn
end

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

An optional label that you can assign to a resource when you create it.

Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



75
76
77
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 75

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 77

def self.jsii_properties
  {
    :configured_table_identifier => "configuredTableIdentifier",
    :membership_identifier => "membershipIdentifier",
    :name => "name",
    :role_arn => "roleArn",
    :configured_table_association_analysis_rules => "configuredTableAssociationAnalysisRules",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'clean_rooms/cfn_configured_table_association_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "configuredTableIdentifier" => @configured_table_identifier,
    "membershipIdentifier" => @membership_identifier,
    "name" => @name,
    "roleArn" => @role_arn,
    "configuredTableAssociationAnalysisRules" => @configured_table_association_analysis_rules,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end