CfnAnalysisTemplateProps Struct
Properties for defining a CfnAnalysisTemplate.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const cfnAnalysisTemplateProps: cleanrooms.CfnAnalysisTemplateProps = {
format: 'format',
membershipIdentifier: 'membershipIdentifier',
name: 'name',
source: {
artifacts: {
entryPoint: {
location: {
bucket: 'bucket',
key: 'key',
},
},
roleArn: 'roleArn',
// the properties below are optional
additionalArtifacts: [{
location: {
bucket: 'bucket',
key: 'key',
},
}],
},
text: 'text',
},
// the properties below are optional
analysisParameters: [{
name: 'name',
type: 'type',
// the properties below are optional
defaultValue: 'defaultValue',
}],
description: 'description',
errorMessageConfiguration: {
type: 'type',
},
schema: {
referencedTables: ['referencedTables'],
},
sourceMetadata: {
artifacts: {
entryPointHash: {
sha256: 'sha256',
},
// the properties below are optional
additionalArtifactHashes: [{
sha256: 'sha256',
}],
},
},
syntheticDataParameters: {
mlSyntheticDataParameters: {
columnClassification: {
columnMapping: [{
columnName: 'columnName',
columnType: 'columnType',
isPredictiveValue: false,
}],
},
epsilon: 123,
maxMembershipInferenceAttackScore: 123,
},
},
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
analysisParametersIResolvable | IResolvable | CfnAnalysisTemplate.AnalysisParameterProperty[]analysis_parameterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AnalysisParameterProperty]]]analysisParametersIResolvableAnalysisParametersIResolvableAnalysisParametersinterface{}#The parameters of the analysis template.
The description of the analysis template.
errorMessageConfigurationIResolvable | CfnAnalysisTemplate.ErrorMessageConfigurationPropertyerror_message_configurationtyping.Union[IResolvable, ErrorMessageConfigurationProperty]errorMessageConfigurationIResolvableErrorMessageConfigurationIResolvableErrorMessageConfigurationinterface{}#The configuration that specifies the level of detail in error messages returned by analyses using this template.
notes
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.
The format of the analysis template.
membershipIdentifierstringmembership_identifierstrmembershipIdentifierStringMembershipIdentifierstringMembershipIdentifier*stringrequired#The identifier for a membership resource.
The name of the analysis template.
schemaIResolvable | CfnAnalysisTemplate.AnalysisSchemaPropertyschematyping.Union[IResolvable, AnalysisSchemaProperty]schemaIResolvableSchemaIResolvableSchemainterface{}#The entire schema object.
sourceIResolvable | CfnAnalysisTemplate.AnalysisSourcePropertysourcetyping.Union[IResolvable, AnalysisSourceProperty]sourceIResolvableSourceIResolvableSourceinterface{}required#The source of the analysis template.
sourceMetadataIResolvable | CfnAnalysisTemplate.AnalysisSourceMetadataPropertysource_metadatatyping.Union[IResolvable, AnalysisSourceMetadataProperty]sourceMetadataIResolvableSourceMetadataIResolvableSourceMetadatainterface{}#The source metadata for the analysis template.
syntheticDataParametersIResolvable | CfnAnalysisTemplate.SyntheticDataParametersPropertysynthetic_data_parameterstyping.Union[IResolvable, SyntheticDataParametersProperty]syntheticDataParametersIResolvableSyntheticDataParametersIResolvableSyntheticDataParametersinterface{}#The parameters used to generate synthetic data for this analysis template.
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.