AWS::CleanRooms Construct Library
All classes with the
Cfnprefix 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:
- Search Construct Hub for CleanRooms construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::CleanRooms resources directly.
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
| Name | Kind | Summary |
|---|---|---|
CfnAnalysisTemplate | Construct (L1) | Creates a new analysis template. |
CfnCollaboration | Construct (L1) | Creates a new collaboration. |
CfnConfiguredTable | Construct (L1) | Creates a new configured table resource. |
CfnConfiguredTableAssociation | Construct (L1) | Creates a configured table association. |
CfnIdMappingTable | Construct (L1) | Describes information about the ID mapping table. |
CfnIdNamespaceAssociation | Construct (L1) | Provides information to create the ID namespace association. |
CfnIntermediateTable | Construct (L1) | Represents an intermediate table that stores cached query results within a collaboration. |
CfnMembership | Construct (L1) | Creates a membership for a specific collaboration identifier and joins the collaboration. |
CfnPrivacyBudgetTemplate | Construct (L1) | An object that defines the privacy budget template. |
CfnAnalysisTemplate.AnalysisParameterProperty | Struct | Optional. |
CfnAnalysisTemplate.AnalysisSchemaProperty | Struct | A relation within an analysis. |
CfnAnalysisTemplate.AnalysisSourceMetadataProperty | Struct | The analysis source metadata. |
CfnAnalysisTemplate.AnalysisSourceProperty | Struct | The structure that defines the body of the analysis template. |
CfnAnalysisTemplate.AnalysisTemplateArtifactMetadataProperty | Struct | The analysis template artifact metadata. |
CfnAnalysisTemplate.AnalysisTemplateArtifactProperty | Struct | The analysis template artifact. |
CfnAnalysisTemplate.AnalysisTemplateArtifactsProperty | Struct | The analysis template artifacts. |
CfnAnalysisTemplate.ColumnClassificationDetailsProperty | Struct | Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis. |
CfnAnalysisTemplate.ErrorMessageConfigurationProperty | Struct | A structure that defines the level of detail included in error messages returned by PySpark jobs. |
CfnAnalysisTemplate.HashProperty | Struct | Hash. |
CfnAnalysisTemplate.MLSyntheticDataParametersProperty | Struct | Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details. |
CfnAnalysisTemplate.S3LocationProperty | Struct | The S3 location. |
CfnAnalysisTemplate.SyntheticDataColumnPropertiesProperty | Struct | Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling. |
CfnAnalysisTemplate.SyntheticDataParametersProperty | Struct | The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process. |
CfnAnalysisTemplateProps | Struct | Properties for defining a CfnAnalysisTemplate. |
CfnCollaboration.DataEncryptionMetadataProperty | Struct | The settings for client-side encryption for cryptographic computing. |
CfnCollaboration.JobComputePaymentConfigProperty | Struct | An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs. |
CfnCollaboration.MemberSpecificationProperty | Struct | Basic metadata used to construct a new member. |
CfnCollaboration.MLMemberAbilitiesProperty | Struct | The ML member abilities for a collaboration member. |
CfnCollaboration.MLPaymentConfigProperty | Struct | An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator. |
CfnCollaboration.ModelInferencePaymentConfigProperty | Struct | An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator. |
CfnCollaboration.ModelTrainingPaymentConfigProperty | Struct | An object representing the collaboration member's model training payment responsibilities set by the collaboration creator. |
CfnCollaboration.PaymentConfigurationProperty | Struct | An object representing the collaboration member's payment responsibilities set by the collaboration creator. |
CfnCollaboration.QueryComputePaymentConfigProperty | Struct | An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs. |
CfnCollaboration.SyntheticDataGenerationPaymentConfigProperty | Struct | Payment configuration for synthetic data generation. |
CfnCollaborationProps | Struct | Properties for defining a CfnCollaboration. |
CfnConfiguredTable.AggregateColumnProperty | Struct | Column in configured table that can be used in aggregate function in query. |
CfnConfiguredTable.AggregationConstraintProperty | Struct | Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column. |
CfnConfiguredTable.AggregationThresholdProperty | Struct | |
CfnConfiguredTable.AnalysisRuleAggregationProperty | Struct | A type of analysis rule that enables query structure and specified queries that produce aggregate statistics. |
CfnConfiguredTable.AnalysisRuleCustomProperty | Struct | A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. |
CfnConfiguredTable.AnalysisRuleListProperty | Struct | A type of analysis rule that enables row-level analysis. |
CfnConfiguredTable.AnalysisRuleProperty | Struct | A specification about how data from the configured table can be used in a query. |
CfnConfiguredTable.AthenaTableReferenceProperty | Struct | A reference to a table within Athena. |
CfnConfiguredTable.ComparisonControlsProperty | Struct | |
CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyProperty | Struct | Controls on the query specifications that can be run on a configured table. |
CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyV1Property | Struct | Controls on the query specifications that can be run on a configured table. |
CfnConfiguredTable.DifferentialPrivacyColumnProperty | Struct | Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect. |
CfnConfiguredTable.DifferentialPrivacyProperty | Struct | The analysis method allowed for the configured tables. |
CfnConfiguredTable.GlueTableReferenceProperty | Struct | A reference to a table within an AWS Glue data catalog. |
CfnConfiguredTable.OutputColumnThresholdProperty | Struct | |
CfnConfiguredTable.SnowflakeTableReferenceProperty | Struct | A reference to a table within Snowflake. |
CfnConfiguredTable.SnowflakeTableSchemaProperty | Struct | The schema of a Snowflake table. |
CfnConfiguredTable.SnowflakeTableSchemaV1Property | Struct | The Snowflake table schema. |
CfnConfiguredTable.TableReferenceProperty | Struct | A pointer to the dataset that underlies this table. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty | Struct | The configured table association analysis rule applied to a configured table with the aggregation analysis rule. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty | Struct | The configured table association analysis rule applied to a configured table with the custom analysis rule. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty | Struct | The configured table association analysis rule applied to a configured table with the list analysis rule. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyProperty | Struct | Controls on the query specifications that can be run on an associated configured table. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property | Struct | Controls on the query specifications that can be run on an associated configured table. |
CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleProperty | Struct | An analysis rule for a configured table association. |
CfnConfiguredTableAssociationProps | Struct | Properties for defining a CfnConfiguredTableAssociation. |
CfnConfiguredTableProps | Struct | Properties for defining a CfnConfiguredTable. |
CfnIdMappingTable.IdMappingTableInputReferenceConfigProperty | Struct | Provides the input reference configuration for the ID mapping table. |
CfnIdMappingTable.IdMappingTableInputReferencePropertiesProperty | Struct | The input reference properties for the ID mapping table. |
CfnIdMappingTable.IdMappingTableInputSourceProperty | Struct | The input source of the ID mapping table. |
CfnIdMappingTableProps | Struct | Properties for defining a CfnIdMappingTable. |
CfnIdNamespaceAssociation.IdMappingConfigProperty | Struct | The configuration settings for the ID mapping table. |
CfnIdNamespaceAssociation.IdNamespaceAssociationInputReferenceConfigProperty | Struct | Provides the information for the ID namespace association input reference configuration. |
CfnIdNamespaceAssociation.IdNamespaceAssociationInputReferencePropertiesProperty | Struct | Provides the information for the ID namespace association input reference properties. |
CfnIdNamespaceAssociationProps | Struct | Properties for defining a CfnIdNamespaceAssociation. |
CfnIntermediateTable.AggregationThresholdProperty | Struct | |
CfnIntermediateTable.ComparisonControlsProperty | Struct | |
CfnIntermediateTable.DifferentialPrivacyColumnProperty | Struct | |
CfnIntermediateTable.DifferentialPrivacyProperty | Struct | |
CfnIntermediateTable.IntermediateTableAnalysisRuleCustomProperty | Struct | |
CfnIntermediateTable.IntermediateTableAnalysisRulePolicyProperty | Struct | |
CfnIntermediateTable.IntermediateTableAnalysisRulePolicyV1Property | Struct | |
CfnIntermediateTable.IntermediateTableAnalysisRuleProperty | Struct | |
CfnIntermediateTable.OutputColumnThresholdProperty | Struct | |
CfnIntermediateTable.PopulationAnalysisConfigurationProperty | Struct | |
CfnIntermediateTable.PopulationAnalysisSqlParametersProperty | Struct | |
CfnIntermediateTableProps | Struct | Properties for defining a CfnIntermediateTable. |
CfnMembership.MembershipJobComputePaymentConfigProperty | Struct | An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs. |
CfnMembership.MembershipMLPaymentConfigProperty | Struct | An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator. |
CfnMembership.MembershipModelInferencePaymentConfigProperty | Struct | An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator. |
CfnMembership.MembershipModelTrainingPaymentConfigProperty | Struct | An object representing the collaboration member's model training payment responsibilities set by the collaboration creator. |
CfnMembership.MembershipPaymentConfigurationProperty | Struct | An object representing the payment responsibilities accepted by the collaboration member. |
CfnMembership.MembershipProtectedJobOutputConfigurationProperty | Struct | Contains configurations for protected job results. |
CfnMembership.MembershipProtectedJobResultConfigurationProperty | Struct | Contains configurations for protected job results. |
CfnMembership.MembershipProtectedQueryOutputConfigurationProperty | Struct | Contains configurations for protected query results. |
CfnMembership.MembershipProtectedQueryResultConfigurationProperty | Struct | Contains configurations for protected query results. |
CfnMembership.MembershipQueryComputePaymentConfigProperty | Struct | An object representing the payment responsibilities accepted by the collaboration member for query compute costs. |
CfnMembership.MembershipSyntheticDataGenerationPaymentConfigProperty | Struct | Configuration for payment for synthetic data generation in a membership. |
CfnMembership.ProtectedJobS3OutputConfigurationInputProperty | Struct | Contains input information for protected jobs with an S3 output type. |
CfnMembership.ProtectedQueryS3OutputConfigurationProperty | Struct | Contains the configuration to write the query results to S3. |
CfnMembershipProps | Struct | Properties for defining a CfnMembership. |
CfnPrivacyBudgetTemplate.BudgetParameterProperty | Struct | Individual budget parameter configuration that defines specific budget allocation settings for access budgets. |
CfnPrivacyBudgetTemplate.ParametersProperty | Struct | Specifies the epsilon and noise parameters for the privacy budget template. |
CfnPrivacyBudgetTemplateProps | Struct | Properties for defining a CfnPrivacyBudgetTemplate. |