Class: AWSCDK::CleanRooms::CfnAnalysisTemplate

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

Overview

Creates a new analysis template.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAnalysisTemplate

Create a new AWS::CleanRooms::AnalysisTemplate.

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::CfnAnalysisTemplateProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplateProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5BbmFseXNpc1RlbXBsYXRlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_analysis_template(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'clean_rooms/cfn_analysis_template.rb', line 88

def self.arn_for_analysis_template(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbGVhbnJvb21zLklBbmFseXNpc1RlbXBsYXRlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cleanrooms.CfnAnalysisTemplate", "arnForAnalysisTemplate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'clean_rooms/cfn_analysis_template.rb', line 195

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

.is_cfn_analysis_template(x) ⇒ Boolean

Checks whether the given object is a CfnAnalysisTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'clean_rooms/cfn_analysis_template.rb', line 97

def self.is_cfn_analysis_template(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cleanrooms.CfnAnalysisTemplate", "isCfnAnalysisTemplate", [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
84
 
# File 'clean_rooms/cfn_analysis_template.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 },
    :analysis_template_ref => { kind: :property, name: "analysisTemplateRef", is_optional: false },
    :attr_analysis_template_identifier => { kind: :property, name: "attrAnalysisTemplateIdentifier", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_collaboration_arn => { kind: :property, name: "attrCollaborationArn", is_optional: false },
    :attr_collaboration_identifier => { kind: :property, name: "attrCollaborationIdentifier", is_optional: false },
    :attr_membership_arn => { kind: :property, name: "attrMembershipArn", is_optional: false },
    :attr_schema => { kind: :property, name: "attrSchema", is_optional: false },
    :attr_schema_referenced_tables => { kind: :property, name: "attrSchemaReferencedTables", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :format => { kind: :property, name: "format", is_optional: false },
    :membership_identifier => { kind: :property, name: "membershipIdentifier", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :source => { kind: :property, name: "source", is_optional: false },
    :analysis_parameters => { kind: :property, name: "analysisParameters", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :error_message_configuration => { kind: :property, name: "errorMessageConfiguration", is_optional: true },
    :schema => { kind: :property, name: "schema", is_optional: true },
    :source_metadata => { kind: :property, name: "sourceMetadata", is_optional: true },
    :synthetic_data_parameters => { kind: :property, name: "syntheticDataParameters", 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.



442
443
444
445
 
# File 'clean_rooms/cfn_analysis_template.rb', line 442

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:



454
455
456
457
 
# File 'clean_rooms/cfn_analysis_template.rb', line 454

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:



464
465
466
467
 
# File 'clean_rooms/cfn_analysis_template.rb', line 464

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:



475
476
477
478
479
 
# File 'clean_rooms/cfn_analysis_template.rb', line 475

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.


532
533
534
535
536
 
# File 'clean_rooms/cfn_analysis_template.rb', line 532

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.



542
543
544
545
 
# File 'clean_rooms/cfn_analysis_template.rb', line 542

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.



554
555
556
557
558
 
# File 'clean_rooms/cfn_analysis_template.rb', line 554

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

#analysis_parameters ⇒ AWSCDK::IResolvable, ...

The parameters of the analysis template.

Returns:



320
321
322
 
# File 'clean_rooms/cfn_analysis_template.rb', line 320

def analysis_parameters()
  jsii_get_property("analysisParameters")
end

#analysis_parameters=(value) ⇒ Object 



324
325
326
327
 
# File 'clean_rooms/cfn_analysis_template.rb', line 324

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

#analysis_template_ref ⇒ AWSCDK::Interfaces::AWSCleanrooms::AnalysisTemplateReference

A reference to a AnalysisTemplate resource.

Returns:



202
203
204
 
# File 'clean_rooms/cfn_analysis_template.rb', line 202

def analysis_template_ref()
  jsii_get_property("analysisTemplateRef")
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:



567
568
569
570
 
# File 'clean_rooms/cfn_analysis_template.rb', line 567

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:



589
590
591
592
593
594
 
# File 'clean_rooms/cfn_analysis_template.rb', line 589

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_analysis_template_identifier ⇒ String

Returns the identifier for the analysis template.

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

Returns:

  • (String) 


211
212
213
 
# File 'clean_rooms/cfn_analysis_template.rb', line 211

def attr_analysis_template_identifier()
  jsii_get_property("attrAnalysisTemplateIdentifier")
end

#attr_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the analysis template.

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

Returns:

  • (String) 


220
221
222
 
# File 'clean_rooms/cfn_analysis_template.rb', line 220

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_collaboration_arn ⇒ String

Returns the unique ARN for the analysis template’s associated collaboration.

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

Returns:

  • (String) 


229
230
231
 
# File 'clean_rooms/cfn_analysis_template.rb', line 229

def attr_collaboration_arn()
  jsii_get_property("attrCollaborationArn")
end

#attr_collaboration_identifier ⇒ String

Returns the unique ID for the associated collaboration of the analysis template.

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

Returns:

  • (String) 


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

def attr_collaboration_identifier()
  jsii_get_property("attrCollaborationIdentifier")
end

#attr_membership_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

Returns:

  • (String) 


247
248
249
 
# File 'clean_rooms/cfn_analysis_template.rb', line 247

def attr_membership_arn()
  jsii_get_property("attrMembershipArn")
end

#attr_schema ⇒ AWSCDK::IResolvable

Returns:



252
253
254
 
# File 'clean_rooms/cfn_analysis_template.rb', line 252

def attr_schema()
  jsii_get_property("attrSchema")
end

#attr_schema_referenced_tables ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def attr_schema_referenced_tables()
  jsii_get_property("attrSchemaReferencedTables")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



264
265
266
 
# File 'clean_rooms/cfn_analysis_template.rb', line 264

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'clean_rooms/cfn_analysis_template.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'clean_rooms/cfn_analysis_template.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


598
599
600
601
 
# File 'clean_rooms/cfn_analysis_template.rb', line 598

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}) 


158
159
160
 
# File 'clean_rooms/cfn_analysis_template.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'clean_rooms/cfn_analysis_template.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'clean_rooms/cfn_analysis_template.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the analysis template.

Returns:

  • (String, nil) 


332
333
334
 
# File 'clean_rooms/cfn_analysis_template.rb', line 332

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



336
337
338
339
 
# File 'clean_rooms/cfn_analysis_template.rb', line 336

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'clean_rooms/cfn_analysis_template.rb', line 170

def env()
  jsii_get_property("env")
end

#error_message_configuration ⇒ AWSCDK::IResolvable, ...

The configuration that specifies the level of detail in error messages returned by analyses using this template.

Returns:



344
345
346
 
# File 'clean_rooms/cfn_analysis_template.rb', line 344

def error_message_configuration()
  jsii_get_property("errorMessageConfiguration")
end

#error_message_configuration=(value) ⇒ Object 



348
349
350
351
352
 
# File 'clean_rooms/cfn_analysis_template.rb', line 348

def error_message_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::ErrorMessageConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuRXJyb3JNZXNzYWdlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "errorMessageConfiguration") unless value.nil?
  jsii_set_property("errorMessageConfiguration", value)
end

#format ⇒ String

The format of the analysis template.

Returns:

  • (String) 


271
272
273
 
# File 'clean_rooms/cfn_analysis_template.rb', line 271

def format()
  jsii_get_property("format")
end

#format=(value) ⇒ Object 



275
276
277
278
 
# File 'clean_rooms/cfn_analysis_template.rb', line 275

def format=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  jsii_set_property("format", value)
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:



611
612
613
614
615
 
# File 'clean_rooms/cfn_analysis_template.rb', line 611

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:



622
623
624
625
 
# File 'clean_rooms/cfn_analysis_template.rb', line 622

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:



692
693
694
695
 
# File 'clean_rooms/cfn_analysis_template.rb', line 692

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


122
123
124
 
# File 'clean_rooms/cfn_analysis_template.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#membership_identifier ⇒ String

The identifier for a membership resource.

Returns:

  • (String) 


283
284
285
 
# File 'clean_rooms/cfn_analysis_template.rb', line 283

def membership_identifier()
  jsii_get_property("membershipIdentifier")
end

#membership_identifier=(value) ⇒ Object 



287
288
289
290
 
# File 'clean_rooms/cfn_analysis_template.rb', line 287

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

#name ⇒ String

The name of the analysis template.

Returns:

  • (String) 


295
296
297
 
# File 'clean_rooms/cfn_analysis_template.rb', line 295

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



299
300
301
302
 
# File 'clean_rooms/cfn_analysis_template.rb', line 299

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) 


105
106
107
 
# File 'clean_rooms/cfn_analysis_template.rb', line 105

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:



633
634
635
 
# File 'clean_rooms/cfn_analysis_template.rb', line 633

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:



640
641
642
 
# File 'clean_rooms/cfn_analysis_template.rb', line 640

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.



433
434
435
436
 
# File 'clean_rooms/cfn_analysis_template.rb', line 433

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

#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) 


141
142
143
 
# File 'clean_rooms/cfn_analysis_template.rb', line 141

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:



651
652
653
654
 
# File 'clean_rooms/cfn_analysis_template.rb', line 651

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}) 


658
659
660
661
 
# File 'clean_rooms/cfn_analysis_template.rb', line 658

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:



668
669
670
671
672
 
# File 'clean_rooms/cfn_analysis_template.rb', line 668

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

#schema ⇒ AWSCDK::IResolvable, ...

The entire schema object.

Returns:



357
358
359
 
# File 'clean_rooms/cfn_analysis_template.rb', line 357

def schema()
  jsii_get_property("schema")
end

#schema=(value) ⇒ Object 



361
362
363
364
365
 
# File 'clean_rooms/cfn_analysis_template.rb', line 361

def schema=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSchemaProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTY2hlbWFQcm9wZXJ0eSJ9XX19")), "schema") unless value.nil?
  jsii_set_property("schema", value)
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.



677
678
679
 
# File 'clean_rooms/cfn_analysis_template.rb', line 677

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

#source ⇒ AWSCDK::IResolvable, AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceProperty

The source of the analysis template.

Returns:



307
308
309
 
# File 'clean_rooms/cfn_analysis_template.rb', line 307

def source()
  jsii_get_property("source")
end

#source=(value) ⇒ Object 



311
312
313
314
315
 
# File 'clean_rooms/cfn_analysis_template.rb', line 311

def source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTb3VyY2VQcm9wZXJ0eSJ9XX19")), "source")
  jsii_set_property("source", value)
end

#source_metadata ⇒ AWSCDK::IResolvable, ...

The source metadata for the analysis template.

Returns:



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

def source_metadata()
  jsii_get_property("sourceMetadata")
end

#source_metadata=(value) ⇒ Object 



374
375
376
377
378
 
# File 'clean_rooms/cfn_analysis_template.rb', line 374

def source_metadata=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceMetadataProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTb3VyY2VNZXRhZGF0YVByb3BlcnR5In1dfX0=")), "sourceMetadata") unless value.nil?
  jsii_set_property("sourceMetadata", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



131
132
133
 
# File 'clean_rooms/cfn_analysis_template.rb', line 131

def stack()
  jsii_get_property("stack")
end

#synthetic_data_parameters ⇒ AWSCDK::IResolvable, ...

The parameters used to generate synthetic data for this analysis template.

Returns:



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

def synthetic_data_parameters()
  jsii_get_property("syntheticDataParameters")
end

#synthetic_data_parameters=(value) ⇒ Object 



387
388
389
390
391
 
# File 'clean_rooms/cfn_analysis_template.rb', line 387

def synthetic_data_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::SyntheticDataParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuU3ludGhldGljRGF0YVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "syntheticDataParameters") unless value.nil?
  jsii_set_property("syntheticDataParameters", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



396
397
398
 
# File 'clean_rooms/cfn_analysis_template.rb', line 396

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



400
401
402
403
404
 
# File 'clean_rooms/cfn_analysis_template.rb', line 400

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



409
410
411
 
# File 'clean_rooms/cfn_analysis_template.rb', line 409

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}) 


178
179
180
 
# File 'clean_rooms/cfn_analysis_template.rb', line 178

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}) 


188
189
190
 
# File 'clean_rooms/cfn_analysis_template.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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) 


422
423
424
425
426
427
 
# File 'clean_rooms/cfn_analysis_template.rb', line 422

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