Class: AWSCDK::CleanRooms::CfnCollaboration

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCleanrooms::ICollaborationRef
Defined in:
clean_rooms/cfn_collaboration.rb

Overview

Creates a new collaboration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCollaboration

Create a new AWS::CleanRooms::Collaboration.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CleanRooms::CfnCollaborationProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'clean_rooms/cfn_collaboration.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnCollaborationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5Db2xsYWJvcmF0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_collaboration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'clean_rooms/cfn_collaboration.rb', line 87

def self.arn_for_collaboration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbGVhbnJvb21zLklDb2xsYWJvcmF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cleanrooms.CfnCollaboration", "arnForCollaboration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'clean_rooms/cfn_collaboration.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cleanrooms.CfnCollaboration", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_collaboration(x) ⇒ Boolean

Checks whether the given object is a CfnCollaboration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'clean_rooms/cfn_collaboration.rb', line 96

def self.is_cfn_collaboration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cleanrooms.CfnCollaboration", "isCfnCollaboration", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'clean_rooms/cfn_collaboration.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_collaboration_identifier => { kind: :property, name: "attrCollaborationIdentifier", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :collaboration_ref => { kind: :property, name: "collaborationRef", is_optional: false },
    :creator_display_name => { kind: :property, name: "creatorDisplayName", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :query_log_status => { kind: :property, name: "queryLogStatus", is_optional: false },
    :allowed_result_regions => { kind: :property, name: "allowedResultRegions", is_optional: true },
    :analytics_engine => { kind: :property, name: "analyticsEngine", is_optional: true },
    :auto_approved_change_types => { kind: :property, name: "autoApprovedChangeTypes", is_optional: true },
    :creator_member_abilities => { kind: :property, name: "creatorMemberAbilities", is_optional: true },
    :creator_ml_member_abilities => { kind: :property, name: "creatorMlMemberAbilities", is_optional: true },
    :creator_payment_configuration => { kind: :property, name: "creatorPaymentConfiguration", is_optional: true },
    :data_encryption_metadata => { kind: :property, name: "dataEncryptionMetadata", is_optional: true },
    :is_metrics_enabled => { kind: :property, name: "isMetricsEnabled", is_optional: true },
    :job_log_status => { kind: :property, name: "jobLogStatus", is_optional: true },
    :members => { kind: :property, name: "members", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



448
449
450
451
 
# File 'clean_rooms/cfn_collaboration.rb', line 448

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



460
461
462
463
 
# File 'clean_rooms/cfn_collaboration.rb', line 460

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



470
471
472
473
 
# File 'clean_rooms/cfn_collaboration.rb', line 470

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



481
482
483
484
485
 
# File 'clean_rooms/cfn_collaboration.rb', line 481

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


538
539
540
541
542
 
# File 'clean_rooms/cfn_collaboration.rb', line 538

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



548
549
550
551
 
# File 'clean_rooms/cfn_collaboration.rb', line 548

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



560
561
562
563
564
 
# File 'clean_rooms/cfn_collaboration.rb', line 560

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#allowed_result_regions ⇒ Array<String>?

The AWS Regions where collaboration query results can be stored.

Returns:

  • (Array<String>, nil) 


281
282
283
 
# File 'clean_rooms/cfn_collaboration.rb', line 281

def allowed_result_regions()
  jsii_get_property("allowedResultRegions")
end

#allowed_result_regions=(value) ⇒ Object 



285
286
287
288
 
# File 'clean_rooms/cfn_collaboration.rb', line 285

def allowed_result_regions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedResultRegions") unless value.nil?
  jsii_set_property("allowedResultRegions", value)
end

#analytics_engine ⇒ String?

The analytics engine for the collaboration.

Returns:

  • (String, nil) 


293
294
295
 
# File 'clean_rooms/cfn_collaboration.rb', line 293

def analytics_engine()
  jsii_get_property("analyticsEngine")
end

#analytics_engine=(value) ⇒ Object 



297
298
299
300
 
# File 'clean_rooms/cfn_collaboration.rb', line 297

def analytics_engine=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "analyticsEngine") unless value.nil?
  jsii_set_property("analyticsEngine", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



573
574
575
576
 
# File 'clean_rooms/cfn_collaboration.rb', line 573

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



595
596
597
598
599
600
 
# File 'clean_rooms/cfn_collaboration.rb', line 595

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the specified collaboration.

Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Returns:

  • (String) 


203
204
205
 
# File 'clean_rooms/cfn_collaboration.rb', line 203

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_collaboration_identifier ⇒ String

Returns the unique identifier of the specified collaboration.

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Returns:

  • (String) 


212
213
214
 
# File 'clean_rooms/cfn_collaboration.rb', line 212

def attr_collaboration_identifier()
  jsii_get_property("attrCollaborationIdentifier")
end

#auto_approved_change_types ⇒ Array<String>?

The types of change requests that are automatically approved for this collaboration.

Returns:

  • (Array<String>, nil) 


305
306
307
 
# File 'clean_rooms/cfn_collaboration.rb', line 305

def auto_approved_change_types()
  jsii_get_property("autoApprovedChangeTypes")
end

#auto_approved_change_types=(value) ⇒ Object 



309
310
311
312
 
# File 'clean_rooms/cfn_collaboration.rb', line 309

def auto_approved_change_types=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "autoApprovedChangeTypes") unless value.nil?
  jsii_set_property("autoApprovedChangeTypes", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



219
220
221
 
# File 'clean_rooms/cfn_collaboration.rb', line 219

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



147
148
149
 
# File 'clean_rooms/cfn_collaboration.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'clean_rooms/cfn_collaboration.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


604
605
606
607
 
# File 'clean_rooms/cfn_collaboration.rb', line 604

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


157
158
159
 
# File 'clean_rooms/cfn_collaboration.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'clean_rooms/cfn_collaboration.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#collaboration_ref ⇒ AWSCDK::Interfaces::AWSCleanrooms::CollaborationReference

A reference to a Collaboration resource.

Returns:



226
227
228
 
# File 'clean_rooms/cfn_collaboration.rb', line 226

def collaboration_ref()
  jsii_get_property("collaborationRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'clean_rooms/cfn_collaboration.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#creator_display_name ⇒ String

A display name of the collaboration creator.

Returns:

  • (String) 


233
234
235
 
# File 'clean_rooms/cfn_collaboration.rb', line 233

def creator_display_name()
  jsii_get_property("creatorDisplayName")
end

#creator_display_name=(value) ⇒ Object 



237
238
239
240
 
# File 'clean_rooms/cfn_collaboration.rb', line 237

def creator_display_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "creatorDisplayName")
  jsii_set_property("creatorDisplayName", value)
end

#creator_member_abilities ⇒ Array<String>?

The abilities granted to the collaboration creator.

Returns:

  • (Array<String>, nil) 


317
318
319
 
# File 'clean_rooms/cfn_collaboration.rb', line 317

def creator_member_abilities()
  jsii_get_property("creatorMemberAbilities")
end

#creator_member_abilities=(value) ⇒ Object 



321
322
323
324
 
# File 'clean_rooms/cfn_collaboration.rb', line 321

def creator_member_abilities=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "creatorMemberAbilities") unless value.nil?
  jsii_set_property("creatorMemberAbilities", value)
end

#creator_ml_member_abilities ⇒ AWSCDK::IResolvable, ...

The ML member abilities for a collaboration member.

Returns:



329
330
331
 
# File 'clean_rooms/cfn_collaboration.rb', line 329

def creator_ml_member_abilities()
  jsii_get_property("creatorMlMemberAbilities")
end

#creator_ml_member_abilities=(value) ⇒ Object 



333
334
335
336
337
 
# File 'clean_rooms/cfn_collaboration.rb', line 333

def creator_ml_member_abilities=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnCollaboration::MLMemberAbilitiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkNvbGxhYm9yYXRpb24uTUxNZW1iZXJBYmlsaXRpZXNQcm9wZXJ0eSJ9XX19")), "creatorMlMemberAbilities") unless value.nil?
  jsii_set_property("creatorMlMemberAbilities", value)
end

#creator_payment_configuration ⇒ AWSCDK::IResolvable, ...

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

Returns:



342
343
344
 
# File 'clean_rooms/cfn_collaboration.rb', line 342

def creator_payment_configuration()
  jsii_get_property("creatorPaymentConfiguration")
end

#creator_payment_configuration=(value) ⇒ Object 



346
347
348
349
350
 
# File 'clean_rooms/cfn_collaboration.rb', line 346

def creator_payment_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnCollaboration::PaymentConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkNvbGxhYm9yYXRpb24uUGF5bWVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "creatorPaymentConfiguration") unless value.nil?
  jsii_set_property("creatorPaymentConfiguration", value)
end

#data_encryption_metadata ⇒ AWSCDK::IResolvable, ...

The settings for client-side encryption for cryptographic computing.

Returns:



355
356
357
 
# File 'clean_rooms/cfn_collaboration.rb', line 355

def data_encryption_metadata()
  jsii_get_property("dataEncryptionMetadata")
end

#data_encryption_metadata=(value) ⇒ Object 



359
360
361
362
363
 
# File 'clean_rooms/cfn_collaboration.rb', line 359

def data_encryption_metadata=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnCollaboration::DataEncryptionMetadataProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkNvbGxhYm9yYXRpb24uRGF0YUVuY3J5cHRpb25NZXRhZGF0YVByb3BlcnR5In1dfX0=")), "dataEncryptionMetadata") unless value.nil?
  jsii_set_property("dataEncryptionMetadata", value)
end

#description ⇒ String

A description of the collaboration provided by the collaboration owner.

Returns:

  • (String) 


245
246
247
 
# File 'clean_rooms/cfn_collaboration.rb', line 245

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



249
250
251
252
 
# File 'clean_rooms/cfn_collaboration.rb', line 249

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'clean_rooms/cfn_collaboration.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



617
618
619
620
621
 
# File 'clean_rooms/cfn_collaboration.rb', line 617

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



628
629
630
631
 
# File 'clean_rooms/cfn_collaboration.rb', line 628

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



698
699
700
701
 
# File 'clean_rooms/cfn_collaboration.rb', line 698

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#is_metrics_enabled ⇒ Boolean, ...

Returns:



366
367
368
 
# File 'clean_rooms/cfn_collaboration.rb', line 366

def is_metrics_enabled()
  jsii_get_property("isMetricsEnabled")
end

#is_metrics_enabled=(value) ⇒ Object 



370
371
372
373
 
# File 'clean_rooms/cfn_collaboration.rb', line 370

def is_metrics_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isMetricsEnabled") unless value.nil?
  jsii_set_property("isMetricsEnabled", value)
end

#job_log_status ⇒ String?

An indicator as to whether job logging has been enabled or disabled for the collaboration.

Returns:

  • (String, nil) 


378
379
380
 
# File 'clean_rooms/cfn_collaboration.rb', line 378

def job_log_status()
  jsii_get_property("jobLogStatus")
end

#job_log_status=(value) ⇒ Object 



382
383
384
385
 
# File 'clean_rooms/cfn_collaboration.rb', line 382

def job_log_status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobLogStatus") unless value.nil?
  jsii_set_property("jobLogStatus", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


121
122
123
 
# File 'clean_rooms/cfn_collaboration.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#members ⇒ AWSCDK::IResolvable, ...

A list of initial members, not including the creator.

Returns:



390
391
392
 
# File 'clean_rooms/cfn_collaboration.rb', line 390

def members()
  jsii_get_property("members")
end

#members=(value) ⇒ Object 



394
395
396
397
 
# File 'clean_rooms/cfn_collaboration.rb', line 394

def members=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5Db2xsYWJvcmF0aW9uLk1lbWJlclNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "members") unless value.nil?
  jsii_set_property("members", value)
end

#name ⇒ String

A human-readable identifier provided by the collaboration owner.

Returns:

  • (String) 


257
258
259
 
# File 'clean_rooms/cfn_collaboration.rb', line 257

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



261
262
263
264
 
# File 'clean_rooms/cfn_collaboration.rb', line 261

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'clean_rooms/cfn_collaboration.rb', line 104

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



639
640
641
 
# File 'clean_rooms/cfn_collaboration.rb', line 639

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



646
647
648
 
# File 'clean_rooms/cfn_collaboration.rb', line 646

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



439
440
441
442
 
# File 'clean_rooms/cfn_collaboration.rb', line 439

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#query_log_status ⇒ String

An indicator as to whether query logging has been enabled or disabled for the collaboration.

Returns:

  • (String) 


269
270
271
 
# File 'clean_rooms/cfn_collaboration.rb', line 269

def query_log_status()
  jsii_get_property("queryLogStatus")
end

#query_log_status=(value) ⇒ Object 



273
274
275
276
 
# File 'clean_rooms/cfn_collaboration.rb', line 273

def query_log_status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryLogStatus")
  jsii_set_property("queryLogStatus", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


140
141
142
 
# File 'clean_rooms/cfn_collaboration.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



657
658
659
660
 
# File 'clean_rooms/cfn_collaboration.rb', line 657

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


664
665
666
667
 
# File 'clean_rooms/cfn_collaboration.rb', line 664

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



674
675
676
677
678
 
# File 'clean_rooms/cfn_collaboration.rb', line 674

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



683
684
685
 
# File 'clean_rooms/cfn_collaboration.rb', line 683

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



130
131
132
 
# File 'clean_rooms/cfn_collaboration.rb', line 130

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



402
403
404
 
# File 'clean_rooms/cfn_collaboration.rb', line 402

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



406
407
408
409
410
 
# File 'clean_rooms/cfn_collaboration.rb', line 406

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



415
416
417
 
# File 'clean_rooms/cfn_collaboration.rb', line 415

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'clean_rooms/cfn_collaboration.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'clean_rooms/cfn_collaboration.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


689
690
691
692
 
# File 'clean_rooms/cfn_collaboration.rb', line 689

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


428
429
430
431
432
433
 
# File 'clean_rooms/cfn_collaboration.rb', line 428

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end