CfnAnalysisTemplate

format

The identifier for a membership resource.

membershipIdentifier

name

source

analysisParameters

The description of the analysis template.

description

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.

errorMessageConfiguration

schema

The source metadata for the analysis template.

sourceMetadata

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

syntheticDataParameters

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.

CfnCollaboration

A display name of the collaboration creator.

creatorDisplayName

A description of the collaboration provided by the collaboration owner.

A human-readable identifier provided by the collaboration owner.

Display names are not unique.

An indicator as to whether query logging has been enabled or disabled for the collaboration.

When `ENABLED` , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .

queryLogStatus

The AWS Regions where collaboration query results can be stored.

Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

allowedResultRegions

The analytics engine for the collaboration.

> After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available.

analyticsEngine

The types of change requests that are automatically approved for this collaboration.

autoApprovedChangeTypes

The abilities granted to the collaboration creator.

*Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS` | `CAN_RUN_JOB`

creatorMemberAbilities

The ML member abilities for a collaboration member.

creatorMlMemberAbilities

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

creatorPaymentConfiguration

The settings for client-side encryption for cryptographic computing.

dataEncryptionMetadata

isMetricsEnabled

An indicator as to whether job logging has been enabled or disabled for the collaboration.

When `ENABLED` , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .

jobLogStatus

A list of initial members, not including the creator.

This list is immutable.

members

CfnConfiguredTable

The columns within the underlying AWS Glue table that can be used within collaborations.

allowedColumns

The analysis method for the configured table.

`DIRECT_QUERY` allows SQL queries to be run directly on this table.

`DIRECT_JOB` allows PySpark jobs to be run directly on this table.

`MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.

analysisMethod

The table that this configured table represents.

tableReference

The analysis rule that was created for the configured table.

analysisRules

The selected analysis methods for the configured table.

selectedAnalysisMethods

Creates a configured table association.

A configured table association links a configured table with a collaboration.

CfnConfiguredTableAssociation

A unique identifier for the configured table to be associated to.

Currently accepts a configured table ID.

configuredTableIdentifier

The unique ID for the membership this configured table association belongs to.

The name of the configured table association, in lowercase.

The table is identified by this name when running protected queries against the underlying data.

The service will assume this role to access catalog metadata and query the table.

roleArn

An analysis rule for a configured table association.

This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule* .

configuredTableAssociationAnalysisRules

A description of the configured table association.

Describes information about the ID mapping table.

CfnIdMappingTable

The input reference configuration for the ID mapping table.

inputReferenceConfig

The unique identifier of the membership resource for the ID mapping table.

The Amazon Resource Name (ARN) of the AWS KMS key.

kmsKeyArn

Provides information to create the ID namespace association.

CfnIdNamespaceAssociation

The input reference configuration for the ID namespace association.

The unique identifier of the membership that contains the ID namespace association.

The name of this ID namespace association.

The description of the ID namespace association.

The configuration settings for the ID mapping table.

idMappingConfig

Creates a membership for a specific collaboration identifier and joins the collaboration.

CfnMembership

The unique ID for the associated collaboration.

collaborationIdentifier

An indicator as to whether query logging has been enabled or disabled for the membership.

When `ENABLED` , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED` .

The default job result configuration for the membership.

defaultJobResultConfiguration

The default protected query result configuration as specified by the member who can receive results.

defaultResultConfiguration

The payment responsibilities accepted by the collaboration member.

paymentConfiguration

An object that defines the privacy budget template.

CfnPrivacyBudgetTemplate

How often the privacy budget refreshes.

> If you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

AWS cleanrooms

L1 Constructs8

CfnAnalysisTemplate

CfnCollaboration

CfnConfiguredTable

CfnConfiguredTableAssociation

CfnIdMappingTable

CfnIdNamespaceAssociation

CfnMembership

CfnPrivacyBudgetTemplate

Learn AWS the Practical Way

Quick Facts

Related Links

More AWS cleanrooms deep dives