interface CfnAnalysisTemplateProps

Language	Type name
.NET	Amazon.CDK.aws_cleanrooms.CfnAnalysisTemplateProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnAnalysisTemplateProps
Java	software.amazon.awscdk.services.cleanrooms.CfnAnalysisTemplateProps
Python	aws_cdk.aws_cleanrooms.CfnAnalysisTemplateProps
TypeScript	aws-cdk-lib » aws_cleanrooms » CfnAnalysisTemplateProps

Properties for defining a CfnAnalysisTemplate.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html

Example

// 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',
      }],
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
format	string	The format of the analysis template.
membershipIdentifier	string	The identifier for a membership resource.
name	string	The name of the analysis template.
source	IResolvable | AnalysisSourceProperty	The source of the analysis template.
analysisParameters?	IResolvable | IResolvable | AnalysisParameterProperty[]	The parameters of the analysis template.
description?	string	The description of the analysis template.
errorMessageConfiguration?	IResolvable | ErrorMessageConfigurationProperty	The configuration that specifies the level of detail in error messages returned by analyses using this template.
schema?	IResolvable | AnalysisSchemaProperty	The entire schema object.
sourceMetadata?	IResolvable | AnalysisSourceMetadataProperty	The source metadata for the analysis template.
tags?	CfnTag[]	An optional label that you can assign to a resource when you create it.

---

format

Type: string

The format of the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format

---

membershipIdentifier

Type: string

The identifier for a membership resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier

---

name

Type: string

The name of the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name

---

source

Type: IResolvable | AnalysisSourceProperty

The source of the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source

---

analysisParameters?

Type: IResolvable | IResolvable | AnalysisParameterProperty[] (optional)

The parameters of the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters

---

description?

Type: string (optional)

The description of the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description

---

errorMessageConfiguration?

Type: IResolvable | ErrorMessageConfigurationProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration

---

schema?

Type: IResolvable | AnalysisSchemaProperty (optional)

The entire schema object.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-schema

---

sourceMetadata?

Type: IResolvable | AnalysisSourceMetadataProperty (optional)

The source metadata for the analysis template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-sourcemetadata

---

tags?

Type: CfnTag[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags