Class: AWSCDK::CleanRooms::CfnAnalysisTemplateProps

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

Overview

Properties for defining a CfnAnalysisTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(format:, membership_identifier:, name:, source:, analysis_parameters: nil, description: nil, error_message_configuration: nil, schema: nil, source_metadata: nil, synthetic_data_parameters: nil, tags: nil) ⇒ CfnAnalysisTemplateProps

Returns a new instance of CfnAnalysisTemplateProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 20

def initialize(format:, membership_identifier:, name:, source:, analysis_parameters: nil, description: nil, error_message_configuration: nil, schema: nil, source_metadata: nil, synthetic_data_parameters: nil, tags: nil)
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  @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")
  @source = source.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceProperty.new(**source.transform_keys(&:to_sym)) : source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTb3VyY2VQcm9wZXJ0eSJ9XX19")), "source")
  @analysis_parameters = analysis_parameters
  Jsii::Type.check_type(@analysis_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5BbmFseXNpc1RlbXBsYXRlLkFuYWx5c2lzUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "analysisParameters") unless @analysis_parameters.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @error_message_configuration = error_message_configuration.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::ErrorMessageConfigurationProperty.new(**error_message_configuration.transform_keys(&:to_sym)) : error_message_configuration
  Jsii::Type.check_type(@error_message_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuRXJyb3JNZXNzYWdlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "errorMessageConfiguration") unless @error_message_configuration.nil?
  @schema = schema.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSchemaProperty.new(**schema.transform_keys(&:to_sym)) : schema
  Jsii::Type.check_type(@schema, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTY2hlbWFQcm9wZXJ0eSJ9XX19")), "schema") unless @schema.nil?
  @source_metadata = source_metadata.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceMetadataProperty.new(**source_metadata.transform_keys(&:to_sym)) : source_metadata
  Jsii::Type.check_type(@source_metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuQW5hbHlzaXNTb3VyY2VNZXRhZGF0YVByb3BlcnR5In1dfX0=")), "sourceMetadata") unless @source_metadata.nil?
  @synthetic_data_parameters = synthetic_data_parameters.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnAnalysisTemplate::SyntheticDataParametersProperty.new(**synthetic_data_parameters.transform_keys(&:to_sym)) : synthetic_data_parameters
  Jsii::Type.check_type(@synthetic_data_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbkFuYWx5c2lzVGVtcGxhdGUuU3ludGhldGljRGF0YVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "syntheticDataParameters") unless @synthetic_data_parameters.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

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

The parameters of the analysis template.

Returns:

See Also:



69
70
71
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 69

def analysis_parameters
  @analysis_parameters
end

#description ⇒ String? (readonly)

The description of the analysis template.

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 74

def description
  @description
end

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

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

When set to DETAILED , error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

Returns:

See Also:



81
82
83
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 81

def error_message_configuration
  @error_message_configuration
end

#format ⇒ String (readonly)

The format of the analysis template.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 49

def format
  @format
end

#membership_identifier ⇒ String (readonly)

The identifier for a membership resource.

Returns:

  • (String)

See Also:



54
55
56
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 54

def membership_identifier
  @membership_identifier
end

#name ⇒ String (readonly)

The name of the analysis template.

Returns:

  • (String)

See Also:



59
60
61
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 59

def name
  @name
end

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

The entire schema object.

Returns:

See Also:



86
87
88
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 86

def schema
  @schema
end

#source ⇒ AWSCDK::IResolvable, AWSCDK::CleanRooms::CfnAnalysisTemplate::AnalysisSourceProperty (readonly)

The source of the analysis template.

Returns:

See Also:



64
65
66
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 64

def source
  @source
end

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

The source metadata for the analysis template.

Returns:

See Also:



91
92
93
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 91

def source_metadata
  @source_metadata
end

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

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

Returns:

See Also:



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

def synthetic_data_parameters
  @synthetic_data_parameters
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:



103
104
105
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 103

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 105

def self.jsii_properties
  {
    :format => "format",
    :membership_identifier => "membershipIdentifier",
    :name => "name",
    :source => "source",
    :analysis_parameters => "analysisParameters",
    :description => "description",
    :error_message_configuration => "errorMessageConfiguration",
    :schema => "schema",
    :source_metadata => "sourceMetadata",
    :synthetic_data_parameters => "syntheticDataParameters",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'clean_rooms/cfn_analysis_template_props.rb', line 121

def to_jsii
  result = {}
  result.merge!({
    "format" => @format,
    "membershipIdentifier" => @membership_identifier,
    "name" => @name,
    "source" => @source,
    "analysisParameters" => @analysis_parameters,
    "description" => @description,
    "errorMessageConfiguration" => @error_message_configuration,
    "schema" => @schema,
    "sourceMetadata" => @source_metadata,
    "syntheticDataParameters" => @synthetic_data_parameters,
    "tags" => @tags,
  })
  result.compact
end