AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CleanRooms::AnalysisTemplate

CfnAnalysisTemplate

Creates a new analysis template.

Import

import { CfnAnalysisTemplate } from 'aws-cdk-lib/aws-cleanrooms';

Or use the module namespace:

import * as cleanrooms from 'aws-cdk-lib/aws-cleanrooms';
// cleanrooms.CfnAnalysisTemplate

Properties

Configuration passed to the constructor as CfnAnalysisTemplateProps.

formatRequired
string

The format of the analysis template.

membershipIdentifierRequired
string

The identifier for a membership resource.

nameRequired
string

The name of the analysis template.

sourceRequired
IResolvable | AnalysisSourceProperty

The source of the analysis template.

analysisParametersOptional
IResolvable | IResolvable | AnalysisParameterProperty[]

The parameters of the analysis template.

descriptionOptional
string

The description of the analysis template.

errorMessageConfigurationOptional
IResolvable | ErrorMessageConfigurationProperty

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.

schemaOptional
IResolvable | AnalysisSchemaProperty

The entire schema object.

sourceMetadataOptional
IResolvable | AnalysisSourceMetadataProperty

The source metadata for the analysis template.

syntheticDataParametersOptional
IResolvable | SyntheticDataParametersProperty

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

tagsOptional
CfnTag[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter