Skip to content
v2.274.0

AWS::CleanRooms Construct Library ​


cfn-resources: Stable

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.


This module is part of the AWS Cloud Development Kit project.

ts
import * as cleanrooms from 'aws-cdk-lib/aws-cleanrooms';
python
import aws_cdk.aws_cleanrooms as cleanrooms
java
import software.amazon.awscdk.services.cleanrooms.*;
csharp
using Amazon.CDK.AWS.CleanRooms;
go
import cleanrooms "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::CleanRooms.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnAnalysisTemplateConstruct (L1)Creates a new analysis template.
CfnCollaborationConstruct (L1)Creates a new collaboration.
CfnConfiguredTableConstruct (L1)Creates a new configured table resource.
CfnConfiguredTableAssociationConstruct (L1)Creates a configured table association.
CfnIdMappingTableConstruct (L1)Describes information about the ID mapping table.
CfnIdNamespaceAssociationConstruct (L1)Provides information to create the ID namespace association.
CfnIntermediateTableConstruct (L1)Represents an intermediate table that stores cached query results within a collaboration.
CfnMembershipConstruct (L1)Creates a membership for a specific collaboration identifier and joins the collaboration.
CfnPrivacyBudgetTemplateConstruct (L1)An object that defines the privacy budget template.
CfnAnalysisTemplate.AnalysisParameterPropertyStructOptional.
CfnAnalysisTemplate.AnalysisSchemaPropertyStructA relation within an analysis.
CfnAnalysisTemplate.AnalysisSourceMetadataPropertyStructThe analysis source metadata.
CfnAnalysisTemplate.AnalysisSourcePropertyStructThe structure that defines the body of the analysis template.
CfnAnalysisTemplate.AnalysisTemplateArtifactMetadataPropertyStructThe analysis template artifact metadata.
CfnAnalysisTemplate.AnalysisTemplateArtifactPropertyStructThe analysis template artifact.
CfnAnalysisTemplate.AnalysisTemplateArtifactsPropertyStructThe analysis template artifacts.
CfnAnalysisTemplate.ColumnClassificationDetailsPropertyStructContains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.
CfnAnalysisTemplate.ErrorMessageConfigurationPropertyStructA structure that defines the level of detail included in error messages returned by PySpark jobs.
CfnAnalysisTemplate.HashPropertyStructHash.
CfnAnalysisTemplate.MLSyntheticDataParametersPropertyStructParameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details.
CfnAnalysisTemplate.S3LocationPropertyStructThe S3 location.
CfnAnalysisTemplate.SyntheticDataColumnPropertiesPropertyStructProperties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.
CfnAnalysisTemplate.SyntheticDataParametersPropertyStructThe parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.
CfnAnalysisTemplatePropsStructProperties for defining a CfnAnalysisTemplate.
CfnCollaboration.DataEncryptionMetadataPropertyStructThe settings for client-side encryption for cryptographic computing.
CfnCollaboration.JobComputePaymentConfigPropertyStructAn object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.
CfnCollaboration.MemberSpecificationPropertyStructBasic metadata used to construct a new member.
CfnCollaboration.MLMemberAbilitiesPropertyStructThe ML member abilities for a collaboration member.
CfnCollaboration.MLPaymentConfigPropertyStructAn object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
CfnCollaboration.ModelInferencePaymentConfigPropertyStructAn object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
CfnCollaboration.ModelTrainingPaymentConfigPropertyStructAn object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
CfnCollaboration.PaymentConfigurationPropertyStructAn object representing the collaboration member's payment responsibilities set by the collaboration creator.
CfnCollaboration.QueryComputePaymentConfigPropertyStructAn object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
CfnCollaboration.SyntheticDataGenerationPaymentConfigPropertyStructPayment configuration for synthetic data generation.
CfnCollaborationPropsStructProperties for defining a CfnCollaboration.
CfnConfiguredTable.AggregateColumnPropertyStructColumn in configured table that can be used in aggregate function in query.
CfnConfiguredTable.AggregationConstraintPropertyStructConstraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
CfnConfiguredTable.AggregationThresholdPropertyStruct
CfnConfiguredTable.AnalysisRuleAggregationPropertyStructA type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
CfnConfiguredTable.AnalysisRuleCustomPropertyStructA type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.
CfnConfiguredTable.AnalysisRuleListPropertyStructA type of analysis rule that enables row-level analysis.
CfnConfiguredTable.AnalysisRulePropertyStructA specification about how data from the configured table can be used in a query.
CfnConfiguredTable.AthenaTableReferencePropertyStructA reference to a table within Athena.
CfnConfiguredTable.ComparisonControlsPropertyStruct
CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyPropertyStructControls on the query specifications that can be run on a configured table.
CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyV1PropertyStructControls on the query specifications that can be run on a configured table.
CfnConfiguredTable.DifferentialPrivacyColumnPropertyStructSpecifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
CfnConfiguredTable.DifferentialPrivacyPropertyStructThe analysis method allowed for the configured tables.
CfnConfiguredTable.GlueTableReferencePropertyStructA reference to a table within an AWS Glue data catalog.
CfnConfiguredTable.OutputColumnThresholdPropertyStruct
CfnConfiguredTable.SnowflakeTableReferencePropertyStructA reference to a table within Snowflake.
CfnConfiguredTable.SnowflakeTableSchemaPropertyStructThe schema of a Snowflake table.
CfnConfiguredTable.SnowflakeTableSchemaV1PropertyStructThe Snowflake table schema.
CfnConfiguredTable.TableReferencePropertyStructA pointer to the dataset that underlies this table.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationPropertyStructThe configured table association analysis rule applied to a configured table with the aggregation analysis rule.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomPropertyStructThe configured table association analysis rule applied to a configured table with the custom analysis rule.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListPropertyStructThe configured table association analysis rule applied to a configured table with the list analysis rule.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyPropertyStructControls on the query specifications that can be run on an associated configured table.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1PropertyStructControls on the query specifications that can be run on an associated configured table.
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePropertyStructAn analysis rule for a configured table association.
CfnConfiguredTableAssociationPropsStructProperties for defining a CfnConfiguredTableAssociation.
CfnConfiguredTablePropsStructProperties for defining a CfnConfiguredTable.
CfnIdMappingTable.IdMappingTableInputReferenceConfigPropertyStructProvides the input reference configuration for the ID mapping table.
CfnIdMappingTable.IdMappingTableInputReferencePropertiesPropertyStructThe input reference properties for the ID mapping table.
CfnIdMappingTable.IdMappingTableInputSourcePropertyStructThe input source of the ID mapping table.
CfnIdMappingTablePropsStructProperties for defining a CfnIdMappingTable.
CfnIdNamespaceAssociation.IdMappingConfigPropertyStructThe configuration settings for the ID mapping table.
CfnIdNamespaceAssociation.IdNamespaceAssociationInputReferenceConfigPropertyStructProvides the information for the ID namespace association input reference configuration.
CfnIdNamespaceAssociation.IdNamespaceAssociationInputReferencePropertiesPropertyStructProvides the information for the ID namespace association input reference properties.
CfnIdNamespaceAssociationPropsStructProperties for defining a CfnIdNamespaceAssociation.
CfnIntermediateTable.AggregationThresholdPropertyStruct
CfnIntermediateTable.ComparisonControlsPropertyStruct
CfnIntermediateTable.DifferentialPrivacyColumnPropertyStruct
CfnIntermediateTable.DifferentialPrivacyPropertyStruct
CfnIntermediateTable.IntermediateTableAnalysisRuleCustomPropertyStruct
CfnIntermediateTable.IntermediateTableAnalysisRulePolicyPropertyStruct
CfnIntermediateTable.IntermediateTableAnalysisRulePolicyV1PropertyStruct
CfnIntermediateTable.IntermediateTableAnalysisRulePropertyStruct
CfnIntermediateTable.OutputColumnThresholdPropertyStruct
CfnIntermediateTable.PopulationAnalysisConfigurationPropertyStruct
CfnIntermediateTable.PopulationAnalysisSqlParametersPropertyStruct
CfnIntermediateTablePropsStructProperties for defining a CfnIntermediateTable.
CfnMembership.MembershipJobComputePaymentConfigPropertyStructAn object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.
CfnMembership.MembershipMLPaymentConfigPropertyStructAn object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
CfnMembership.MembershipModelInferencePaymentConfigPropertyStructAn object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
CfnMembership.MembershipModelTrainingPaymentConfigPropertyStructAn object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
CfnMembership.MembershipPaymentConfigurationPropertyStructAn object representing the payment responsibilities accepted by the collaboration member.
CfnMembership.MembershipProtectedJobOutputConfigurationPropertyStructContains configurations for protected job results.
CfnMembership.MembershipProtectedJobResultConfigurationPropertyStructContains configurations for protected job results.
CfnMembership.MembershipProtectedQueryOutputConfigurationPropertyStructContains configurations for protected query results.
CfnMembership.MembershipProtectedQueryResultConfigurationPropertyStructContains configurations for protected query results.
CfnMembership.MembershipQueryComputePaymentConfigPropertyStructAn object representing the payment responsibilities accepted by the collaboration member for query compute costs.
CfnMembership.MembershipSyntheticDataGenerationPaymentConfigPropertyStructConfiguration for payment for synthetic data generation in a membership.
CfnMembership.ProtectedJobS3OutputConfigurationInputPropertyStructContains input information for protected jobs with an S3 output type.
CfnMembership.ProtectedQueryS3OutputConfigurationPropertyStructContains the configuration to write the query results to S3.
CfnMembershipPropsStructProperties for defining a CfnMembership.
CfnPrivacyBudgetTemplate.BudgetParameterPropertyStructIndividual budget parameter configuration that defines specific budget allocation settings for access budgets.
CfnPrivacyBudgetTemplate.ParametersPropertyStructSpecifies the epsilon and noise parameters for the privacy budget template.
CfnPrivacyBudgetTemplatePropsStructProperties for defining a CfnPrivacyBudgetTemplate.