This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS Clean Rooms **Resource types** + [AWS::CleanRooms::AnalysisTemplate](aws-resource-cleanrooms-analysistemplate.md) + [AWS::CleanRooms::Collaboration](aws-resource-cleanrooms-collaboration.md) + [AWS::CleanRooms::ConfiguredTable](aws-resource-cleanrooms-configuredtable.md) + [AWS::CleanRooms::ConfiguredTableAssociation](aws-resource-cleanrooms-configuredtableassociation.md) + [AWS::CleanRooms::IdMappingTable](aws-resource-cleanrooms-idmappingtable.md) + [AWS::CleanRooms::IdNamespaceAssociation](aws-resource-cleanrooms-idnamespaceassociation.md) + [AWS::CleanRooms::Membership](aws-resource-cleanrooms-membership.md) + [AWS::CleanRooms::PrivacyBudgetTemplate](aws-resource-cleanrooms-privacybudgettemplate.md) # AWS::CleanRooms::AnalysisTemplate Creates a new analysis template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::AnalysisTemplate", "Properties" : { "[AnalysisParameters](#cfn-cleanrooms-analysistemplate-analysisparameters)" : [ AnalysisParameter, ... ], "[Description](#cfn-cleanrooms-analysistemplate-description)" : String, "[ErrorMessageConfiguration](#cfn-cleanrooms-analysistemplate-errormessageconfiguration)" : ErrorMessageConfiguration, "[Format](#cfn-cleanrooms-analysistemplate-format)" : String, "[MembershipIdentifier](#cfn-cleanrooms-analysistemplate-membershipidentifier)" : String, "[Name](#cfn-cleanrooms-analysistemplate-name)" : String, "[Schema](#cfn-cleanrooms-analysistemplate-schema)" : AnalysisSchema, "[Source](#cfn-cleanrooms-analysistemplate-source)" : AnalysisSource, "[SourceMetadata](#cfn-cleanrooms-analysistemplate-sourcemetadata)" : AnalysisSourceMetadata, "[SyntheticDataParameters](#cfn-cleanrooms-analysistemplate-syntheticdataparameters)" : SyntheticDataParameters, "[Tags](#cfn-cleanrooms-analysistemplate-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::AnalysisTemplate Properties: [AnalysisParameters](#cfn-cleanrooms-analysistemplate-analysisparameters): - AnalysisParameter [Description](#cfn-cleanrooms-analysistemplate-description): String [ErrorMessageConfiguration](#cfn-cleanrooms-analysistemplate-errormessageconfiguration): ErrorMessageConfiguration [Format](#cfn-cleanrooms-analysistemplate-format): String [MembershipIdentifier](#cfn-cleanrooms-analysistemplate-membershipidentifier): String [Name](#cfn-cleanrooms-analysistemplate-name): String [Schema](#cfn-cleanrooms-analysistemplate-schema): AnalysisSchema [Source](#cfn-cleanrooms-analysistemplate-source): AnalysisSource [SourceMetadata](#cfn-cleanrooms-analysistemplate-sourcemetadata): AnalysisSourceMetadata [SyntheticDataParameters](#cfn-cleanrooms-analysistemplate-syntheticdataparameters): SyntheticDataParameters [Tags](#cfn-cleanrooms-analysistemplate-tags): - Tag ``` ## Properties `AnalysisParameters` The parameters of the analysis template. *Required*: No *Type*: Array of [AnalysisParameter](aws-properties-cleanrooms-analysistemplate-analysisparameter.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` The description of the analysis template. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorMessageConfiguration` 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. *Required*: No *Type*: [ErrorMessageConfiguration](aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Format` The format of the analysis template. *Required*: Yes *Type*: String *Allowed values*: `SQL | PYSPARK_1_0` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MembershipIdentifier` The identifier for a membership resource. *Required*: Yes *Type*: String *Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the analysis template. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Schema` The entire schema object. *Required*: No *Type*: [AnalysisSchema](aws-properties-cleanrooms-analysistemplate-analysisschema.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Source` The source of the analysis template. *Required*: Yes *Type*: [AnalysisSource](aws-properties-cleanrooms-analysistemplate-analysissource.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SourceMetadata` The source metadata for the analysis template. *Required*: No *Type*: [AnalysisSourceMetadata](aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SyntheticDataParameters` The parameters used to generate synthetic data for this analysis template. *Required*: No *Type*: [SyntheticDataParameters](aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-analysistemplate-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `AnalysisTemplateIdentifier`, such as `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`. For example: `{ "Ref": "myAnalysisTemplate" }` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `AnalysisTemplateIdentifier` Returns the identifier for the analysis template. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222` `Arn` Returns the Amazon Resource Name (ARN) of the analysis template. Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222` `CollaborationArn` Returns the unique ARN for the analysis template’s associated collaboration. Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` `CollaborationIdentifier` Returns the unique ID for the associated collaboration of the analysis template. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` `MembershipArn` Returns the Amazon Resource Name (ARN) of the member who created the analysis template. Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` ## Examples ### Create an analysis template The following example creates an analysis template. #### JSON ``` { "ExampleAnalysisTemplate": { "Type": "AWS::CleanRooms::AnalysisTemplate", "Properties": { "MembershipIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE1111", "Name": "exampleAnalysisTemplate", "Description": "example description", "Source": { "Text": "SELECT * FROM cta1 WHERE cta1.column1 > :Param1 AND cta1.column2 like :Param2" }, "Format": "SQL", "AnalysisParameters": [ { "Name": "Param1", "Type": "SMALLINT", "DefaultValue": 1 }, { "Name": "Param2", "Type": "CHAR" } ], "Tags": [ { "Key": "Hello", "Value": "World" } ] } } } ``` #### YAML ``` ExampleAnalysisTemplate: Type: 'AWS::CleanRooms::AnalysisTemplate' Properties: MembershipIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE1111 Name: exampleAnalysisTemplate Description: example description Source: Text: SELECT * FROM cta1 WHERE cta1.column1 > :Param1 AND cta1.column2 like :Param2 Format: SQL AnalysisParameters: - Name: Param1 Type: SMALLINT DefaultValue: 1 - Name: Param2 Type: CHAR Tags: - Key: Hello Value: World ``` # AWS::CleanRooms::AnalysisTemplate AnalysisParameter Optional. The member who can query can provide this placeholder for a literal data value in an analysis template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValue](#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue)" : String, "[Name](#cfn-cleanrooms-analysistemplate-analysisparameter-name)" : String, "[Type](#cfn-cleanrooms-analysistemplate-analysisparameter-type)" : String } ``` ### YAML ``` [DefaultValue](#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue): String [Name](#cfn-cleanrooms-analysistemplate-analysisparameter-name): String [Type](#cfn-cleanrooms-analysistemplate-analysisparameter-type): String ``` ## Properties `DefaultValue` Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `1000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the parameter. The name must use only alphanumeric or underscore (\$1) characters. *Required*: Yes *Type*: String *Pattern*: `[0-9a-zA-Z_]+` *Minimum*: `1` *Maximum*: `100` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The type of parameter. *Required*: Yes *Type*: String *Allowed values*: `SMALLINT | INTEGER | BIGINT | DECIMAL | REAL | DOUBLE_PRECISION | BOOLEAN | CHAR | VARCHAR | DATE | TIMESTAMP | TIMESTAMPTZ | TIME | TIMETZ | VARBYTE | BINARY | BYTE | CHARACTER | DOUBLE | FLOAT | INT | LONG | NUMERIC | SHORT | STRING | TIMESTAMP_LTZ | TIMESTAMP_NTZ | TINYINT` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate AnalysisSchema A relation within an analysis. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReferencedTables](#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables)" : [ String, ... ] } ``` ### YAML ``` [ReferencedTables](#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables): - String ``` ## Properties `ReferencedTables` The tables referenced in the analysis schema. *Required*: Yes *Type*: Array of String *Minimum*: `0` *Update requires*: Updates are not supported. # AWS::CleanRooms::AnalysisTemplate AnalysisSource The structure that defines the body of the analysis template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Artifacts](#cfn-cleanrooms-analysistemplate-analysissource-artifacts)" : AnalysisTemplateArtifacts, "[Text](#cfn-cleanrooms-analysistemplate-analysissource-text)" : String } ``` ### YAML ``` [Artifacts](#cfn-cleanrooms-analysistemplate-analysissource-artifacts): AnalysisTemplateArtifacts [Text](#cfn-cleanrooms-analysistemplate-analysissource-text): String ``` ## Properties `Artifacts` The artifacts of the analysis source. *Required*: No *Type*: [AnalysisTemplateArtifacts](aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Text` The query text. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `90000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate AnalysisSourceMetadata The analysis source metadata. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Artifacts](#cfn-cleanrooms-analysistemplate-analysissourcemetadata-artifacts)" : AnalysisTemplateArtifactMetadata } ``` ### YAML ``` [Artifacts](#cfn-cleanrooms-analysistemplate-analysissourcemetadata-artifacts): AnalysisTemplateArtifactMetadata ``` ## Properties `Artifacts` The artifacts of the analysis source metadata. *Required*: Yes *Type*: [AnalysisTemplateArtifactMetadata](aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::AnalysisTemplate AnalysisTemplateArtifact The analysis template artifact. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Location](#cfn-cleanrooms-analysistemplate-analysistemplateartifact-location)" : S3Location } ``` ### YAML ``` [Location](#cfn-cleanrooms-analysistemplate-analysistemplateartifact-location): S3Location ``` ## Properties `Location` The artifact location. *Required*: Yes *Type*: [S3Location](aws-properties-cleanrooms-analysistemplate-s3location.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate AnalysisTemplateArtifactMetadata The analysis template artifact metadata. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalArtifactHashes](#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-additionalartifacthashes)" : [ Hash, ... ], "[EntryPointHash](#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-entrypointhash)" : Hash } ``` ### YAML ``` [AdditionalArtifactHashes](#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-additionalartifacthashes): - Hash [EntryPointHash](#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-entrypointhash): Hash ``` ## Properties `AdditionalArtifactHashes` Additional artifact hashes for the analysis template. *Required*: No *Type*: Array of [Hash](aws-properties-cleanrooms-analysistemplate-hash.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntryPointHash` The hash of the entry point for the analysis template artifact metadata. *Required*: Yes *Type*: [Hash](aws-properties-cleanrooms-analysistemplate-hash.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::AnalysisTemplate AnalysisTemplateArtifacts The analysis template artifacts. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalArtifacts](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-additionalartifacts)" : [ AnalysisTemplateArtifact, ... ], "[EntryPoint](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-entrypoint)" : AnalysisTemplateArtifact, "[RoleArn](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-rolearn)" : String } ``` ### YAML ``` [AdditionalArtifacts](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-additionalartifacts): - AnalysisTemplateArtifact [EntryPoint](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-entrypoint): AnalysisTemplateArtifact [RoleArn](#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-rolearn): String ``` ## Properties `AdditionalArtifacts` Additional artifacts for the analysis template. *Required*: No *Type*: Array of [AnalysisTemplateArtifact](aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EntryPoint` The entry point for the analysis template artifacts. *Required*: Yes *Type*: [AnalysisTemplateArtifact](aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RoleArn` The role ARN for the analysis template artifacts. *Required*: Yes *Type*: String *Minimum*: `32` *Maximum*: `512` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate ColumnClassificationDetails Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnMapping](#cfn-cleanrooms-analysistemplate-columnclassificationdetails-columnmapping)" : [ SyntheticDataColumnProperties, ... ] } ``` ### YAML ``` [ColumnMapping](#cfn-cleanrooms-analysistemplate-columnclassificationdetails-columnmapping): - SyntheticDataColumnProperties ``` ## Properties `ColumnMapping` A mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process. *Required*: Yes *Type*: Array of [SyntheticDataColumnProperties](aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.md) *Minimum*: `5` *Maximum*: `1000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate ErrorMessageConfiguration A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-cleanrooms-analysistemplate-errormessageconfiguration-type)" : String } ``` ### YAML ``` [Type](#cfn-cleanrooms-analysistemplate-errormessageconfiguration-type): String ``` ## Properties `Type` The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job. Because this setting may expose sensitive data, it is recommended for development and testing environments. *Required*: Yes *Type*: String *Allowed values*: `DETAILED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate Hash Hash ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Sha256](#cfn-cleanrooms-analysistemplate-hash-sha256)" : String } ``` ### YAML ``` [Sha256](#cfn-cleanrooms-analysistemplate-hash-sha256): String ``` ## Properties `Sha256` The SHA-256 hash value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::AnalysisTemplate MLSyntheticDataParameters Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnClassification](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-columnclassification)" : ColumnClassificationDetails, "[Epsilon](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-epsilon)" : Number, "[MaxMembershipInferenceAttackScore](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-maxmembershipinferenceattackscore)" : Number } ``` ### YAML ``` [ColumnClassification](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-columnclassification): ColumnClassificationDetails [Epsilon](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-epsilon): Number [MaxMembershipInferenceAttackScore](#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-maxmembershipinferenceattackscore): Number ``` ## Properties `ColumnClassification` Classification details for data columns that specify how each column should be treated during synthetic data generation. *Required*: Yes *Type*: [ColumnClassificationDetails](aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Epsilon` The epsilon value for differential privacy when generating synthetic data. Lower values provide stronger privacy guarantees but may reduce data utility. *Required*: Yes *Type*: Number *Minimum*: `0` *Maximum*: `10` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MaxMembershipInferenceAttackScore` The maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold. *Required*: Yes *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate S3Location The S3 location. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-cleanrooms-analysistemplate-s3location-bucket)" : String, "[Key](#cfn-cleanrooms-analysistemplate-s3location-key)" : String } ``` ### YAML ``` [Bucket](#cfn-cleanrooms-analysistemplate-s3location-bucket): String [Key](#cfn-cleanrooms-analysistemplate-s3location-key): String ``` ## Properties `Bucket` The bucket name. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Key` The object key. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9!_.*'()-/]+` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate SyntheticDataColumnProperties Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columnname)" : String, "[ColumnType](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columntype)" : String, "[IsPredictiveValue](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-ispredictivevalue)" : Boolean } ``` ### YAML ``` [ColumnName](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columnname): String [ColumnType](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columntype): String [IsPredictiveValue](#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-ispredictivevalue): Boolean ``` ## Properties `ColumnName` The name of the data column as it appears in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9_](([a-z0-9_]+-)*([a-z0-9_]+))?$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ColumnType` The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column. *Required*: Yes *Type*: String *Allowed values*: `CATEGORICAL | NUMERICAL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IsPredictiveValue` Indicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate SyntheticDataParameters The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MlSyntheticDataParameters](#cfn-cleanrooms-analysistemplate-syntheticdataparameters-mlsyntheticdataparameters)" : MLSyntheticDataParameters } ``` ### YAML ``` [MlSyntheticDataParameters](#cfn-cleanrooms-analysistemplate-syntheticdataparameters-mlsyntheticdataparameters): MLSyntheticDataParameters ``` ## Properties `MlSyntheticDataParameters` The machine learning-specific parameters for synthetic data generation. *Required*: Yes *Type*: [MLSyntheticDataParameters](aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::AnalysisTemplate Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-analysistemplate-tag-key)" : String, "[Value](#cfn-cleanrooms-analysistemplate-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-analysistemplate-tag-key): String [Value](#cfn-cleanrooms-analysistemplate-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Collaboration Creates a new collaboration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::Collaboration", "Properties" : { "[AllowedResultRegions](#cfn-cleanrooms-collaboration-allowedresultregions)" : [ String, ... ], "[AnalyticsEngine](#cfn-cleanrooms-collaboration-analyticsengine)" : String, "[AutoApprovedChangeTypes](#cfn-cleanrooms-collaboration-autoapprovedchangetypes)" : [ String, ... ], "[CreatorDisplayName](#cfn-cleanrooms-collaboration-creatordisplayname)" : String, "[CreatorMemberAbilities](#cfn-cleanrooms-collaboration-creatormemberabilities)" : [ String, ... ], "[CreatorMLMemberAbilities](#cfn-cleanrooms-collaboration-creatormlmemberabilities)" : MLMemberAbilities, "[CreatorPaymentConfiguration](#cfn-cleanrooms-collaboration-creatorpaymentconfiguration)" : PaymentConfiguration, "[DataEncryptionMetadata](#cfn-cleanrooms-collaboration-dataencryptionmetadata)" : DataEncryptionMetadata, "[Description](#cfn-cleanrooms-collaboration-description)" : String, "[IsMetricsEnabled](#cfn-cleanrooms-collaboration-ismetricsenabled)" : Boolean, "[JobLogStatus](#cfn-cleanrooms-collaboration-joblogstatus)" : String, "[Members](#cfn-cleanrooms-collaboration-members)" : [ MemberSpecification, ... ], "[Name](#cfn-cleanrooms-collaboration-name)" : String, "[QueryLogStatus](#cfn-cleanrooms-collaboration-querylogstatus)" : String, "[Tags](#cfn-cleanrooms-collaboration-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::Collaboration Properties: [AllowedResultRegions](#cfn-cleanrooms-collaboration-allowedresultregions): - String [AnalyticsEngine](#cfn-cleanrooms-collaboration-analyticsengine): String [AutoApprovedChangeTypes](#cfn-cleanrooms-collaboration-autoapprovedchangetypes): - String [CreatorDisplayName](#cfn-cleanrooms-collaboration-creatordisplayname): String [CreatorMemberAbilities](#cfn-cleanrooms-collaboration-creatormemberabilities): - String [CreatorMLMemberAbilities](#cfn-cleanrooms-collaboration-creatormlmemberabilities): MLMemberAbilities [CreatorPaymentConfiguration](#cfn-cleanrooms-collaboration-creatorpaymentconfiguration): PaymentConfiguration [DataEncryptionMetadata](#cfn-cleanrooms-collaboration-dataencryptionmetadata): DataEncryptionMetadata [Description](#cfn-cleanrooms-collaboration-description): String [IsMetricsEnabled](#cfn-cleanrooms-collaboration-ismetricsenabled): Boolean [JobLogStatus](#cfn-cleanrooms-collaboration-joblogstatus): String [Members](#cfn-cleanrooms-collaboration-members): - MemberSpecification [Name](#cfn-cleanrooms-collaboration-name): String [QueryLogStatus](#cfn-cleanrooms-collaboration-querylogstatus): String [Tags](#cfn-cleanrooms-collaboration-tags): - Tag ``` ## Properties `AllowedResultRegions` 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. *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AnalyticsEngine` The analytics engine for the collaboration. After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available. *Required*: No *Type*: String *Allowed values*: `CLEAN_ROOMS_SQL | SPARK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AutoApprovedChangeTypes` The types of change requests that are automatically approved for this collaboration. *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreatorDisplayName` A display name of the collaboration creator. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreatorMemberAbilities` The abilities granted to the collaboration creator. *Allowed values*`CAN_QUERY` \$1 `CAN_RECEIVE_RESULTS` \$1 `CAN_RUN_JOB` *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreatorMLMemberAbilities` The ML member abilities for a collaboration member. *Required*: No *Type*: [MLMemberAbilities](aws-properties-cleanrooms-collaboration-mlmemberabilities.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreatorPaymentConfiguration` An object representing the collaboration member's payment responsibilities set by the collaboration creator. *Required*: No *Type*: [PaymentConfiguration](aws-properties-cleanrooms-collaboration-paymentconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DataEncryptionMetadata` The settings for client-side encryption for cryptographic computing. *Required*: No *Type*: [DataEncryptionMetadata](aws-properties-cleanrooms-collaboration-dataencryptionmetadata.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` A description of the collaboration provided by the collaboration owner. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsMetricsEnabled` An indicator as to whether metrics are enabled for the collaboration. When `true`, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JobLogStatus` 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`. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Members` A list of initial members, not including the creator. This list is immutable. *Required*: No *Type*: Array of [MemberSpecification](aws-properties-cleanrooms-collaboration-memberspecification.md) *Minimum*: `0` *Maximum*: `9` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` A human-readable identifier provided by the collaboration owner. Display names are not unique. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryLogStatus` 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`. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-collaboration-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `CollaborationIdentifier`, such as `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. For example: `{ "Ref": "MyCollaboration" }` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` Returns the Amazon Resource Name (ARN) of the specified collaboration. Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` `CollaborationIdentifier` Returns the unique identifier of the specified collaboration. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` ## Examples ### Create a collaboration The following example creates a collaboration with the collaboration creator. #### JSON ``` "ExampleCollaboration": { { "Type": "AWS::CleanRooms::Collaboration", "Properties": { "Name": "Example Collaboration", "Description": "Example AWS Clean Rooms collaboration", "CreatorDisplayName": "Member 1", "CreatorMemberAbilities": ["CAN_QUERY", "CAN_RECEIVE_RESULTS"], "Members": [ { "AccountId": "111122223333", "DisplayName": "Member 2", "MemberAbilities": [] }, { "AccountId": "444455556666", "DisplayName": "Member 3", "MemberAbilities": [] } ], "QueryLogStatus": "ENABLED" } } } ``` #### YAML ``` ExampleCollaboration: Type: AWS::CleanRooms::Collaboration Properties: Name: Example Collaboration Description: Example AWS Clean Rooms collaboration CreatorDisplayName: Member 1 CreatorMemberAbilities: - CAN_QUERY - CAN_RECEIVE_RESULTS Members: - AccountId: 111122223333 DisplayName: Member 2 MemberAbilities: [] - AccountId: 444455556666 DisplayName: Member 3 MemberAbilities: [] QueryLogStatus: ENABLED ``` # AWS::CleanRooms::Collaboration DataEncryptionMetadata The settings for client-side encryption for cryptographic computing. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowCleartext](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext)" : Boolean, "[AllowDuplicates](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates)" : Boolean, "[AllowJoinsOnColumnsWithDifferentNames](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames)" : Boolean, "[PreserveNulls](#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls)" : Boolean } ``` ### YAML ``` [AllowCleartext](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext): Boolean [AllowDuplicates](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates): Boolean [AllowJoinsOnColumnsWithDifferentNames](#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames): Boolean [PreserveNulls](#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls): Boolean ``` ## Properties `AllowCleartext` Indicates whether encrypted tables can contain cleartext data (`TRUE`) or are to cryptographically process every column (`FALSE`). *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AllowDuplicates` Indicates whether Fingerprint columns can contain duplicate entries (`TRUE`) or are to contain only non-repeated values (`FALSE`). *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AllowJoinsOnColumnsWithDifferentNames` Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (`TRUE`) or can only be joined on Fingerprint columns of the same name (`FALSE`). *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PreserveNulls` Indicates whether NULL values are to be copied as NULL to encrypted tables (`TRUE`) or cryptographically processed (`FALSE`). *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration JobComputePaymentConfig An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-collaboration-jobcomputepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-collaboration-jobcomputepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (`TRUE`) or has not configured the collaboration member to pay for query and job compute costs (`FALSE`). Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration. An error is returned if the collaboration creator sets a `FALSE` value for the member who can run queries and jobs. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration MemberSpecification Basic metadata used to construct a new member. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccountId](#cfn-cleanrooms-collaboration-memberspecification-accountid)" : String, "[DisplayName](#cfn-cleanrooms-collaboration-memberspecification-displayname)" : String, "[MemberAbilities](#cfn-cleanrooms-collaboration-memberspecification-memberabilities)" : [ String, ... ], "[MLMemberAbilities](#cfn-cleanrooms-collaboration-memberspecification-mlmemberabilities)" : MLMemberAbilities, "[PaymentConfiguration](#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration)" : PaymentConfiguration } ``` ### YAML ``` [AccountId](#cfn-cleanrooms-collaboration-memberspecification-accountid): String [DisplayName](#cfn-cleanrooms-collaboration-memberspecification-displayname): String [MemberAbilities](#cfn-cleanrooms-collaboration-memberspecification-memberabilities): - String [MLMemberAbilities](#cfn-cleanrooms-collaboration-memberspecification-mlmemberabilities): MLMemberAbilities [PaymentConfiguration](#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration): PaymentConfiguration ``` ## Properties `AccountId` The identifier used to reference members of the collaboration. Currently only supports AWS account ID. *Required*: Yes *Type*: String *Pattern*: `^\d+$` *Minimum*: `12` *Maximum*: `12` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DisplayName` The member's display name. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MemberAbilities` The abilities granted to the collaboration member. *Allowed Values*: `CAN_QUERY` \$1 `CAN_RECEIVE_RESULTS` *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MLMemberAbilities` The ML abilities granted to the collaboration member. *Required*: No *Type*: [MLMemberAbilities](aws-properties-cleanrooms-collaboration-mlmemberabilities.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PaymentConfiguration` The collaboration member's payment responsibilities set by the collaboration creator. If the collaboration creator hasn't speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer. *Required*: No *Type*: [PaymentConfiguration](aws-properties-cleanrooms-collaboration-paymentconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration MLMemberAbilities The ML member abilities for a collaboration member. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomMLMemberAbilities](#cfn-cleanrooms-collaboration-mlmemberabilities-custommlmemberabilities)" : [ String, ... ] } ``` ### YAML ``` [CustomMLMemberAbilities](#cfn-cleanrooms-collaboration-mlmemberabilities-custommlmemberabilities): - String ``` ## Properties `CustomMLMemberAbilities` The custom ML member abilities for a collaboration member. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration MLPaymentConfig An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelInference](#cfn-cleanrooms-collaboration-mlpaymentconfig-modelinference)" : ModelInferencePaymentConfig, "[ModelTraining](#cfn-cleanrooms-collaboration-mlpaymentconfig-modeltraining)" : ModelTrainingPaymentConfig, "[SyntheticDataGeneration](#cfn-cleanrooms-collaboration-mlpaymentconfig-syntheticdatageneration)" : SyntheticDataGenerationPaymentConfig } ``` ### YAML ``` [ModelInference](#cfn-cleanrooms-collaboration-mlpaymentconfig-modelinference): ModelInferencePaymentConfig [ModelTraining](#cfn-cleanrooms-collaboration-mlpaymentconfig-modeltraining): ModelTrainingPaymentConfig [SyntheticDataGeneration](#cfn-cleanrooms-collaboration-mlpaymentconfig-syntheticdatageneration): SyntheticDataGenerationPaymentConfig ``` ## Properties `ModelInference` The payment responsibilities accepted by the member for model inference. *Required*: No *Type*: [ModelInferencePaymentConfig](aws-properties-cleanrooms-collaboration-modelinferencepaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ModelTraining` The payment responsibilities accepted by the member for model training. *Required*: No *Type*: [ModelTrainingPaymentConfig](aws-properties-cleanrooms-collaboration-modeltrainingpaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SyntheticDataGeneration` The payment configuration for machine learning synthetic data generation. *Required*: No *Type*: [SyntheticDataGenerationPaymentConfig](aws-properties-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration ModelInferencePaymentConfig An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-collaboration-modelinferencepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-collaboration-modelinferencepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (`TRUE`) or has not configured the collaboration member to pay for model inference costs (`FALSE`). Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration ModelTrainingPaymentConfig An object representing the collaboration member's model training payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-collaboration-modeltrainingpaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-collaboration-modeltrainingpaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (`TRUE`) or has not configured the collaboration member to pay for model training costs (`FALSE`). Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration PaymentConfiguration An object representing the collaboration member's payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[JobCompute](#cfn-cleanrooms-collaboration-paymentconfiguration-jobcompute)" : JobComputePaymentConfig, "[MachineLearning](#cfn-cleanrooms-collaboration-paymentconfiguration-machinelearning)" : MLPaymentConfig, "[QueryCompute](#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute)" : QueryComputePaymentConfig } ``` ### YAML ``` [JobCompute](#cfn-cleanrooms-collaboration-paymentconfiguration-jobcompute): JobComputePaymentConfig [MachineLearning](#cfn-cleanrooms-collaboration-paymentconfiguration-machinelearning): MLPaymentConfig [QueryCompute](#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute): QueryComputePaymentConfig ``` ## Properties `JobCompute` The compute configuration for the job. *Required*: No *Type*: [JobComputePaymentConfig](aws-properties-cleanrooms-collaboration-jobcomputepaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MachineLearning` An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator. *Required*: No *Type*: [MLPaymentConfig](aws-properties-cleanrooms-collaboration-mlpaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `QueryCompute` The collaboration member's payment responsibilities set by the collaboration creator for query compute costs. *Required*: Yes *Type*: [QueryComputePaymentConfig](aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration QueryComputePaymentConfig An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (`TRUE`) or has not configured the collaboration member to pay for query compute costs (`FALSE`). Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration SyntheticDataGenerationPaymentConfig Payment configuration for synthetic data generation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-collaboration-syntheticdatagenerationpaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates who is responsible for paying for synthetic data generation. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::Collaboration Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-collaboration-tag-key)" : String, "[Value](#cfn-cleanrooms-collaboration-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-collaboration-tag-key): String [Value](#cfn-cleanrooms-collaboration-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable Creates a new configured table resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::ConfiguredTable", "Properties" : { "[AllowedColumns](#cfn-cleanrooms-configuredtable-allowedcolumns)" : [ String, ... ], "[AnalysisMethod](#cfn-cleanrooms-configuredtable-analysismethod)" : String, "[AnalysisRules](#cfn-cleanrooms-configuredtable-analysisrules)" : [ AnalysisRule, ... ], "[Description](#cfn-cleanrooms-configuredtable-description)" : String, "[Name](#cfn-cleanrooms-configuredtable-name)" : String, "[SelectedAnalysisMethods](#cfn-cleanrooms-configuredtable-selectedanalysismethods)" : [ String, ... ], "[TableReference](#cfn-cleanrooms-configuredtable-tablereference)" : TableReference, "[Tags](#cfn-cleanrooms-configuredtable-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::ConfiguredTable Properties: [AllowedColumns](#cfn-cleanrooms-configuredtable-allowedcolumns): - String [AnalysisMethod](#cfn-cleanrooms-configuredtable-analysismethod): String [AnalysisRules](#cfn-cleanrooms-configuredtable-analysisrules): - AnalysisRule [Description](#cfn-cleanrooms-configuredtable-description): String [Name](#cfn-cleanrooms-configuredtable-name): String [SelectedAnalysisMethods](#cfn-cleanrooms-configuredtable-selectedanalysismethods): - String [TableReference](#cfn-cleanrooms-configuredtable-tablereference): TableReference [Tags](#cfn-cleanrooms-configuredtable-tags): - Tag ``` ## Properties `AllowedColumns` The columns within the underlying AWS Glue table that can be used within collaborations. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AnalysisMethod` 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. *Required*: Yes *Type*: String *Allowed values*: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AnalysisRules` The analysis rule that was created for the configured table. *Required*: No *Type*: Array of [AnalysisRule](aws-properties-cleanrooms-configuredtable-analysisrule.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description for the configured table. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the configured table. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SelectedAnalysisMethods` The selected analysis methods for the configured table. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableReference` The table that this configured table represents. *Required*: Yes *Type*: [TableReference](aws-properties-cleanrooms-configuredtable-tablereference.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-configuredtable-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{"Ref": "MyConfiguredTable"}` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` Returns the Amazon Resource Name (ARN) of the specified configured table. Example: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` `ConfiguredTableIdentifier` Returns the unique identifier of the specified configured table. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` ## Examples ### A configured table using a list analysis rule The following is an example of a configured table with a list analysis rule applied. #### JSON ``` "ListConfiguredTable": { { "Type" : "AWS::CleanRooms::ConfiguredTable", "Properties" : { "Name" : "List Table", "Description" : "Example configured table with list AR", "AllowedColumns" : ["column1", "column2", "column4"], "AnalysisMethod" : "DIRECT_QUERY", "AnalysisRules" : [ "Type": "LIST", "Policy": { "V1": { "List": { "JoinColumns": [ "column1" ], "ListColumns": [ "column2" ] } } } ], "TableReference" : { "Glue": { "DatabaseName": "ExampleDB", "TableName": "ExampleTable" } } } } } ``` #### YAML ``` ListConfiguredTable: Type: AWS::CleanRooms::ConfiguredTable Properties: Name: List Table Description: Example configured table with list AR AllowedColumns: - column1 - column2 - column4 AnalysisMethod: DIRECT_QUERY AnalysisRules: - Type: LIST Policy: V1: List: JoinColumns: - column1 ListColumns: - column2 TableReference: Glue: DatabaseName: ExampleDB TableName: ExampleTable ``` # AWS::CleanRooms::ConfiguredTable AggregateColumn Column in configured table that can be used in aggregate function in query. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnNames](#cfn-cleanrooms-configuredtable-aggregatecolumn-columnnames)" : [ String, ... ], "[Function](#cfn-cleanrooms-configuredtable-aggregatecolumn-function)" : String } ``` ### YAML ``` [ColumnNames](#cfn-cleanrooms-configuredtable-aggregatecolumn-columnnames): - String [Function](#cfn-cleanrooms-configuredtable-aggregatecolumn-function): String ``` ## Properties `ColumnNames` Column names in configured table of aggregate columns. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Function` Aggregation function that can be applied to aggregate column in query. *Required*: Yes *Type*: String *Allowed values*: `SUM | SUM_DISTINCT | COUNT | COUNT_DISTINCT | AVG` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AggregationConstraint Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-cleanrooms-configuredtable-aggregationconstraint-columnname)" : String, "[Minimum](#cfn-cleanrooms-configuredtable-aggregationconstraint-minimum)" : Number, "[Type](#cfn-cleanrooms-configuredtable-aggregationconstraint-type)" : String } ``` ### YAML ``` [ColumnName](#cfn-cleanrooms-configuredtable-aggregationconstraint-columnname): String [Minimum](#cfn-cleanrooms-configuredtable-aggregationconstraint-minimum): Number [Type](#cfn-cleanrooms-configuredtable-aggregationconstraint-type): String ``` ## Properties `ColumnName` Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$` *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Minimum` The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output. *Required*: Yes *Type*: Number *Minimum*: `2` *Maximum*: `100000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of aggregation the constraint allows. The only valid value is currently `COUNT\$1DISTINCT`. *Required*: Yes *Type*: String *Allowed values*: `COUNT_DISTINCT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AnalysisRule A specification about how data from the configured table can be used in a query. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Policy](#cfn-cleanrooms-configuredtable-analysisrule-policy)" : ConfiguredTableAnalysisRulePolicy, "[Type](#cfn-cleanrooms-configuredtable-analysisrule-type)" : String } ``` ### YAML ``` [Policy](#cfn-cleanrooms-configuredtable-analysisrule-policy): ConfiguredTableAnalysisRulePolicy [Type](#cfn-cleanrooms-configuredtable-analysisrule-type): String ``` ## Properties `Policy` A policy that describes the associated data usage limitations. *Required*: Yes *Type*: [ConfiguredTableAnalysisRulePolicy](aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of analysis rule. *Required*: Yes *Type*: String *Allowed values*: `AGGREGATION | LIST | CUSTOM` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AnalysisRuleAggregation A type of analysis rule that enables query structure and specified queries that produce aggregate statistics. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisruleaggregation-additionalanalyses)" : String, "[AggregateColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-aggregatecolumns)" : [ AggregateColumn, ... ], "[AllowedJoinOperators](#cfn-cleanrooms-configuredtable-analysisruleaggregation-allowedjoinoperators)" : [ String, ... ], "[DimensionColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-dimensioncolumns)" : [ String, ... ], "[JoinColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-joincolumns)" : [ String, ... ], "[JoinRequired](#cfn-cleanrooms-configuredtable-analysisruleaggregation-joinrequired)" : String, "[OutputConstraints](#cfn-cleanrooms-configuredtable-analysisruleaggregation-outputconstraints)" : [ AggregationConstraint, ... ], "[ScalarFunctions](#cfn-cleanrooms-configuredtable-analysisruleaggregation-scalarfunctions)" : [ String, ... ] } ``` ### YAML ``` [AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisruleaggregation-additionalanalyses): String [AggregateColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-aggregatecolumns): - AggregateColumn [AllowedJoinOperators](#cfn-cleanrooms-configuredtable-analysisruleaggregation-allowedjoinoperators): - String [DimensionColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-dimensioncolumns): - String [JoinColumns](#cfn-cleanrooms-configuredtable-analysisruleaggregation-joincolumns): - String [JoinRequired](#cfn-cleanrooms-configuredtable-analysisruleaggregation-joinrequired): String [OutputConstraints](#cfn-cleanrooms-configuredtable-analysisruleaggregation-outputconstraints): - AggregationConstraint [ScalarFunctions](#cfn-cleanrooms-configuredtable-analysisruleaggregation-scalarfunctions): - String ``` ## Properties `AdditionalAnalyses` An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query. The `additionalAnalyses` parameter is currently supported for the list analysis rule (`AnalysisRuleList`) and the custom analysis rule (`AnalysisRuleCustom`). *Required*: No *Type*: String *Allowed values*: `ALLOWED | REQUIRED | NOT_ALLOWED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AggregateColumns` The columns that query runners are allowed to use in aggregation queries. *Required*: Yes *Type*: Array of [AggregateColumn](aws-properties-cleanrooms-configuredtable-aggregatecolumn.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedJoinOperators` Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is `AND`. *Required*: No *Type*: Array of String *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DimensionColumns` The columns that query runners are allowed to select, group by, or filter by. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinColumns` Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinRequired` Control that requires member who runs query to do a join with their configured table and/or other configured table in query. *Required*: No *Type*: String *Allowed values*: `QUERY_RUNNER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputConstraints` Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned. *Required*: Yes *Type*: Array of [AggregationConstraint](aws-properties-cleanrooms-configuredtable-aggregationconstraint.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScalarFunctions` Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AnalysisRuleCustom A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisrulecustom-additionalanalyses)" : String, "[AllowedAnalyses](#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalyses)" : [ String, ... ], "[AllowedAnalysisProviders](#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalysisproviders)" : [ String, ... ], "[DifferentialPrivacy](#cfn-cleanrooms-configuredtable-analysisrulecustom-differentialprivacy)" : DifferentialPrivacy, "[DisallowedOutputColumns](#cfn-cleanrooms-configuredtable-analysisrulecustom-disallowedoutputcolumns)" : [ String, ... ] } ``` ### YAML ``` [AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisrulecustom-additionalanalyses): String [AllowedAnalyses](#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalyses): - String [AllowedAnalysisProviders](#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalysisproviders): - String [DifferentialPrivacy](#cfn-cleanrooms-configuredtable-analysisrulecustom-differentialprivacy): DifferentialPrivacy [DisallowedOutputColumns](#cfn-cleanrooms-configuredtable-analysisrulecustom-disallowedoutputcolumns): - String ``` ## Properties `AdditionalAnalyses` An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query. *Required*: No *Type*: String *Allowed values*: `ALLOWED | REQUIRED | NOT_ALLOWED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedAnalyses` The ARN of the analysis templates that are allowed by the custom analysis rule. *Required*: Yes *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedAnalysisProviders` The IDs of the AWS accounts that are allowed to query by the custom analysis rule. Required when `allowedAnalyses` is `ANY_QUERY`. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DifferentialPrivacy` The differential privacy configuration. *Required*: No *Type*: [DifferentialPrivacy](aws-properties-cleanrooms-configuredtable-differentialprivacy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisallowedOutputColumns` A list of columns that aren't allowed to be shown in the query output. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AnalysisRuleList A type of analysis rule that enables row-level analysis. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisrulelist-additionalanalyses)" : String, "[AllowedJoinOperators](#cfn-cleanrooms-configuredtable-analysisrulelist-allowedjoinoperators)" : [ String, ... ], "[JoinColumns](#cfn-cleanrooms-configuredtable-analysisrulelist-joincolumns)" : [ String, ... ], "[ListColumns](#cfn-cleanrooms-configuredtable-analysisrulelist-listcolumns)" : [ String, ... ] } ``` ### YAML ``` [AdditionalAnalyses](#cfn-cleanrooms-configuredtable-analysisrulelist-additionalanalyses): String [AllowedJoinOperators](#cfn-cleanrooms-configuredtable-analysisrulelist-allowedjoinoperators): - String [JoinColumns](#cfn-cleanrooms-configuredtable-analysisrulelist-joincolumns): - String [ListColumns](#cfn-cleanrooms-configuredtable-analysisrulelist-listcolumns): - String ``` ## Properties `AdditionalAnalyses` An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query. *Required*: No *Type*: String *Allowed values*: `ALLOWED | REQUIRED | NOT_ALLOWED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedJoinOperators` The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is `AND`. *Required*: No *Type*: Array of String *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinColumns` Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ListColumns` Columns that can be listed in the output. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable AthenaTableReference A reference to a table within Athena. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CatalogName](#cfn-cleanrooms-configuredtable-athenatablereference-catalogname)" : String, "[DatabaseName](#cfn-cleanrooms-configuredtable-athenatablereference-databasename)" : String, "[OutputLocation](#cfn-cleanrooms-configuredtable-athenatablereference-outputlocation)" : String, "[Region](#cfn-cleanrooms-configuredtable-athenatablereference-region)" : String, "[TableName](#cfn-cleanrooms-configuredtable-athenatablereference-tablename)" : String, "[WorkGroup](#cfn-cleanrooms-configuredtable-athenatablereference-workgroup)" : String } ``` ### YAML ``` [CatalogName](#cfn-cleanrooms-configuredtable-athenatablereference-catalogname): String [DatabaseName](#cfn-cleanrooms-configuredtable-athenatablereference-databasename): String [OutputLocation](#cfn-cleanrooms-configuredtable-athenatablereference-outputlocation): String [Region](#cfn-cleanrooms-configuredtable-athenatablereference-region): String [TableName](#cfn-cleanrooms-configuredtable-athenatablereference-tablename): String [WorkGroup](#cfn-cleanrooms-configuredtable-athenatablereference-workgroup): String ``` ## Properties `CatalogName` The catalog name. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseName` The database name. *Required*: Yes *Type*: String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputLocation` The output location for the Athena table. *Required*: No *Type*: String *Minimum*: `8` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Region` The AWS Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions. *Required*: No *Type*: String *Allowed values*: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1 | ap-east-2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableName` The table reference. *Required*: Yes *Type*: String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkGroup` The workgroup of the Athena table reference. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable ConfiguredTableAnalysisRulePolicy Controls on the query specifications that can be run on a configured table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[V1](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicy-v1)" : ConfiguredTableAnalysisRulePolicyV1 } ``` ### YAML ``` [V1](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicy-v1): ConfiguredTableAnalysisRulePolicyV1 ``` ## Properties `V1` Controls on the query specifications that can be run on a configured table. *Required*: Yes *Type*: [ConfiguredTableAnalysisRulePolicyV1](aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable ConfiguredTableAnalysisRulePolicyV1 Controls on the query specifications that can be run on a configured table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Aggregation](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-aggregation)" : AnalysisRuleAggregation, "[Custom](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-custom)" : AnalysisRuleCustom, "[List](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-list)" : AnalysisRuleList } ``` ### YAML ``` [Aggregation](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-aggregation): AnalysisRuleAggregation [Custom](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-custom): AnalysisRuleCustom [List](#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-list): AnalysisRuleList ``` ## Properties `Aggregation` Analysis rule type that enables only aggregation queries on a configured table. *Required*: No *Type*: [AnalysisRuleAggregation](aws-properties-cleanrooms-configuredtable-analysisruleaggregation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Custom` Analysis rule type that enables custom SQL queries on a configured table. *Required*: No *Type*: [AnalysisRuleCustom](aws-properties-cleanrooms-configuredtable-analysisrulecustom.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `List` Analysis rule type that enables only list queries on a configured table. *Required*: No *Type*: [AnalysisRuleList](aws-properties-cleanrooms-configuredtable-analysisrulelist.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable DifferentialPrivacy The analysis method allowed for the configured tables. `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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Columns](#cfn-cleanrooms-configuredtable-differentialprivacy-columns)" : [ DifferentialPrivacyColumn, ... ] } ``` ### YAML ``` [Columns](#cfn-cleanrooms-configuredtable-differentialprivacy-columns): - DifferentialPrivacyColumn ``` ## Properties `Columns` The name of the column, such as user\$1id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules. *Required*: Yes *Type*: Array of [DifferentialPrivacyColumn](aws-properties-cleanrooms-configuredtable-differentialprivacycolumn.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable DifferentialPrivacyColumn Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-cleanrooms-configuredtable-differentialprivacycolumn-name)" : String } ``` ### YAML ``` [Name](#cfn-cleanrooms-configuredtable-differentialprivacycolumn-name): String ``` ## Properties `Name` The name of the column, such as user\$1id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules. *Required*: Yes *Type*: String *Pattern*: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?` *Minimum*: `0` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable GlueTableReference A reference to a table within an AWS Glue data catalog. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseName](#cfn-cleanrooms-configuredtable-gluetablereference-databasename)" : String, "[Region](#cfn-cleanrooms-configuredtable-gluetablereference-region)" : String, "[TableName](#cfn-cleanrooms-configuredtable-gluetablereference-tablename)" : String } ``` ### YAML ``` [DatabaseName](#cfn-cleanrooms-configuredtable-gluetablereference-databasename): String [Region](#cfn-cleanrooms-configuredtable-gluetablereference-region): String [TableName](#cfn-cleanrooms-configuredtable-gluetablereference-tablename): String ``` ## Properties `DatabaseName` The name of the database the AWS Glue table belongs to. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Region` The AWS Region where the AWS Glue table is located. This parameter is required to uniquely identify and access tables across different Regions. *Required*: No *Type*: String *Allowed values*: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1 | ap-east-2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableName` The name of the AWS Glue table. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable SnowflakeTableReference A reference to a table within Snowflake. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccountIdentifier](#cfn-cleanrooms-configuredtable-snowflaketablereference-accountidentifier)" : String, "[DatabaseName](#cfn-cleanrooms-configuredtable-snowflaketablereference-databasename)" : String, "[SchemaName](#cfn-cleanrooms-configuredtable-snowflaketablereference-schemaname)" : String, "[SecretArn](#cfn-cleanrooms-configuredtable-snowflaketablereference-secretarn)" : String, "[TableName](#cfn-cleanrooms-configuredtable-snowflaketablereference-tablename)" : String, "[TableSchema](#cfn-cleanrooms-configuredtable-snowflaketablereference-tableschema)" : SnowflakeTableSchema } ``` ### YAML ``` [AccountIdentifier](#cfn-cleanrooms-configuredtable-snowflaketablereference-accountidentifier): String [DatabaseName](#cfn-cleanrooms-configuredtable-snowflaketablereference-databasename): String [SchemaName](#cfn-cleanrooms-configuredtable-snowflaketablereference-schemaname): String [SecretArn](#cfn-cleanrooms-configuredtable-snowflaketablereference-secretarn): String [TableName](#cfn-cleanrooms-configuredtable-snowflaketablereference-tablename): String [TableSchema](#cfn-cleanrooms-configuredtable-snowflaketablereference-tableschema): SnowflakeTableSchema ``` ## Properties `AccountIdentifier` The account identifier for the Snowflake table reference. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseName` The name of the database the Snowflake table belongs to. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SchemaName` The schema name of the Snowflake table reference. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` The secret ARN of the Snowflake table reference. *Required*: Yes *Type*: String *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableName` The name of the Snowflake table. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableSchema` The schema of the Snowflake table. *Required*: Yes *Type*: [SnowflakeTableSchema](aws-properties-cleanrooms-configuredtable-snowflaketableschema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable SnowflakeTableSchema The schema of a Snowflake table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[V1](#cfn-cleanrooms-configuredtable-snowflaketableschema-v1)" : [ SnowflakeTableSchemaV1, ... ] } ``` ### YAML ``` [V1](#cfn-cleanrooms-configuredtable-snowflaketableschema-v1): - SnowflakeTableSchemaV1 ``` ## Properties `V1` The schema of a Snowflake table. *Required*: Yes *Type*: Array of [SnowflakeTableSchemaV1](aws-properties-cleanrooms-configuredtable-snowflaketableschemav1.md) *Minimum*: `1` *Maximum*: `250` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable SnowflakeTableSchemaV1 The Snowflake table schema. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columnname)" : String, "[ColumnType](#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columntype)" : String } ``` ### YAML ``` [ColumnName](#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columnname): String [ColumnType](#cfn-cleanrooms-configuredtable-snowflaketableschemav1-columntype): String ``` ## Properties `ColumnName` The column name. *Required*: Yes *Type*: String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnType` The column's data type. Supported data types: `ARRAY`, `BIGINT`, `BOOLEAN`, `CHAR`, `DATE`, `DECIMAL`, `DOUBLE`, `DOUBLE PRECISION`, `FLOAT`, `FLOAT4`, `INT`, `INTEGER`, `MAP`, `NUMERIC`, `NUMBER`, `REAL`, `SMALLINT`, `STRING`, `TIMESTAMP`, `TIMESTAMP_LTZ`, `TIMESTAMP_NTZ`, `DATETIME`, `TINYINT`, `VARCHAR`, `TEXT`, `CHARACTER`. *Required*: Yes *Type*: String *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable TableReference A pointer to the dataset that underlies this table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Athena](#cfn-cleanrooms-configuredtable-tablereference-athena)" : AthenaTableReference, "[Glue](#cfn-cleanrooms-configuredtable-tablereference-glue)" : GlueTableReference, "[Snowflake](#cfn-cleanrooms-configuredtable-tablereference-snowflake)" : SnowflakeTableReference } ``` ### YAML ``` [Athena](#cfn-cleanrooms-configuredtable-tablereference-athena): AthenaTableReference [Glue](#cfn-cleanrooms-configuredtable-tablereference-glue): GlueTableReference [Snowflake](#cfn-cleanrooms-configuredtable-tablereference-snowflake): SnowflakeTableReference ``` ## Properties `Athena` If present, a reference to the Athena table referred to by this table reference. *Required*: No *Type*: [AthenaTableReference](aws-properties-cleanrooms-configuredtable-athenatablereference.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Glue` If present, a reference to the AWS Glue table referred to by this table reference. *Required*: No *Type*: [GlueTableReference](aws-properties-cleanrooms-configuredtable-gluetablereference.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Snowflake` If present, a reference to the Snowflake table referred to by this table reference. *Required*: No *Type*: [SnowflakeTableReference](aws-properties-cleanrooms-configuredtable-snowflaketablereference.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTable Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-configuredtable-tag-key)" : String, "[Value](#cfn-cleanrooms-configuredtable-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-configuredtable-tag-key): String [Value](#cfn-cleanrooms-configuredtable-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation Creates a configured table association. A configured table association links a configured table with a collaboration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::ConfiguredTableAssociation", "Properties" : { "[ConfiguredTableAssociationAnalysisRules](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrules)" : [ ConfiguredTableAssociationAnalysisRule, ... ], "[ConfiguredTableIdentifier](#cfn-cleanrooms-configuredtableassociation-configuredtableidentifier)" : String, "[Description](#cfn-cleanrooms-configuredtableassociation-description)" : String, "[MembershipIdentifier](#cfn-cleanrooms-configuredtableassociation-membershipidentifier)" : String, "[Name](#cfn-cleanrooms-configuredtableassociation-name)" : String, "[RoleArn](#cfn-cleanrooms-configuredtableassociation-rolearn)" : String, "[Tags](#cfn-cleanrooms-configuredtableassociation-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::ConfiguredTableAssociation Properties: [ConfiguredTableAssociationAnalysisRules](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrules): - ConfiguredTableAssociationAnalysisRule [ConfiguredTableIdentifier](#cfn-cleanrooms-configuredtableassociation-configuredtableidentifier): String [Description](#cfn-cleanrooms-configuredtableassociation-description): String [MembershipIdentifier](#cfn-cleanrooms-configuredtableassociation-membershipidentifier): String [Name](#cfn-cleanrooms-configuredtableassociation-name): String [RoleArn](#cfn-cleanrooms-configuredtableassociation-rolearn): String [Tags](#cfn-cleanrooms-configuredtableassociation-tags): - Tag ``` ## Properties `ConfiguredTableAssociationAnalysisRules` 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*. *Required*: No *Type*: Array of [ConfiguredTableAssociationAnalysisRule](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConfiguredTableIdentifier` A unique identifier for the configured table to be associated to. Currently accepts a configured table ID. *Required*: Yes *Type*: String *Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` A description of the configured table association. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MembershipIdentifier` The unique ID for the membership this configured table association belongs to. *Required*: Yes *Type*: String *Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RoleArn` The service will assume this role to access catalog metadata and query the table. *Required*: Yes *Type*: String *Minimum*: `32` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-configuredtableassociation-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `ConfiguredTableAssociation` and the ID of the Membership. For example: `c1baf760-935e-4b2d-b36e-af8daaeb6e48|81a97460-2c40-46ce-a2fd-4ccda7398b2c` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` Returns the Amazon Resource Name (ARN) of the specified configured table association. Example: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` `ConfiguredTableAssociationIdentifier` Returns the unique identifier of the specified configured table association. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` ## Examples ### A configured table association The following is an example of a configured table association which associates a configured table to a collaboration. #### JSON ``` "ExampleAssociation": { "Type" : "AWS::CleanRooms::ConfiguredTableAssociation", "Properties" : { "Name" : "Example Table", "Description" : "Example associated configured table", "ConfiguredTableIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "MembershipIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "RoleArn" : "arn:aws:iam::123456789012:role/service-role/cleanrooms-association-example" } } ``` #### YAML ``` ExampleAssociation: Type: AWS::CleanRooms::ConfiguredTableAssociation Properties: Name: Example Table Description: Example associated configured table ConfiguredTableIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" MembershipIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 RoleArn: arn:aws:iam::123456789012:role/service-role/cleanrooms-association-example ``` # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRule 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*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Policy](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-policy)" : ConfiguredTableAssociationAnalysisRulePolicy, "[Type](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-type)" : String } ``` ### YAML ``` [Policy](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-policy): ConfiguredTableAssociationAnalysisRulePolicy [Type](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-type): String ``` ## Properties `Policy` The policy of the configured table association analysis rule. *Required*: Yes *Type*: [ConfiguredTableAssociationAnalysisRulePolicy](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of the configured table association analysis rule. *Required*: Yes *Type*: String *Allowed values*: `AGGREGATION | LIST | CUSTOM` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRuleAggregation The configured table association analysis rule applied to a configured table with the aggregation analysis rule. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedadditionalanalyses)" : [ String, ... ], "[AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedresultreceivers)" : [ String, ... ] } ``` ### YAML ``` [AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedadditionalanalyses): - String [AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedresultreceivers): - String ``` ## Properties `AllowedAdditionalAnalyses` The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. The `allowedAdditionalAnalyses` parameter is currently supported for the list analysis rule (`AnalysisRuleList`) and the custom analysis rule (`AnalysisRuleCustom`). *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedResultReceivers` The list of collaboration members who are allowed to receive results of queries run with this configured table. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRuleCustom The configured table association analysis rule applied to a configured table with the custom analysis rule. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedadditionalanalyses)" : [ String, ... ], "[AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedresultreceivers)" : [ String, ... ] } ``` ### YAML ``` [AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedadditionalanalyses): - String [AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedresultreceivers): - String ``` ## Properties `AllowedAdditionalAnalyses` The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedResultReceivers` The list of collaboration members who are allowed to receive results of queries run with this configured table. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRuleList The configured table association analysis rule applied to a configured table with the list analysis rule. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedadditionalanalyses)" : [ String, ... ], "[AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedresultreceivers)" : [ String, ... ] } ``` ### YAML ``` [AllowedAdditionalAnalyses](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedadditionalanalyses): - String [AllowedResultReceivers](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedresultreceivers): - String ``` ## Properties `AllowedAdditionalAnalyses` The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowedResultReceivers` The list of collaboration members who are allowed to receive results of queries run with this configured table. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRulePolicy Controls on the query specifications that can be run on an associated configured table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[V1](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy-v1)" : ConfiguredTableAssociationAnalysisRulePolicyV1 } ``` ### YAML ``` [V1](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy-v1): ConfiguredTableAssociationAnalysisRulePolicyV1 ``` ## Properties `V1` The policy for the configured table association analysis rule. *Required*: Yes *Type*: [ConfiguredTableAssociationAnalysisRulePolicyV1](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation ConfiguredTableAssociationAnalysisRulePolicyV1 Controls on the query specifications that can be run on an associated configured table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Aggregation](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-aggregation)" : ConfiguredTableAssociationAnalysisRuleAggregation, "[Custom](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-custom)" : ConfiguredTableAssociationAnalysisRuleCustom, "[List](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-list)" : ConfiguredTableAssociationAnalysisRuleList } ``` ### YAML ``` [Aggregation](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-aggregation): ConfiguredTableAssociationAnalysisRuleAggregation [Custom](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-custom): ConfiguredTableAssociationAnalysisRuleCustom [List](#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-list): ConfiguredTableAssociationAnalysisRuleList ``` ## Properties `Aggregation` Analysis rule type that enables only aggregation queries on a configured table. *Required*: No *Type*: [ConfiguredTableAssociationAnalysisRuleAggregation](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Custom` Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy. *Required*: No *Type*: [ConfiguredTableAssociationAnalysisRuleCustom](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `List` Analysis rule type that enables only list queries on a configured table. *Required*: No *Type*: [ConfiguredTableAssociationAnalysisRuleList](aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::ConfiguredTableAssociation Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-configuredtableassociation-tag-key)" : String, "[Value](#cfn-cleanrooms-configuredtableassociation-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-configuredtableassociation-tag-key): String [Value](#cfn-cleanrooms-configuredtableassociation-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdMappingTable Describes information about the ID mapping table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::IdMappingTable", "Properties" : { "[Description](#cfn-cleanrooms-idmappingtable-description)" : String, "[InputReferenceConfig](#cfn-cleanrooms-idmappingtable-inputreferenceconfig)" : IdMappingTableInputReferenceConfig, "[KmsKeyArn](#cfn-cleanrooms-idmappingtable-kmskeyarn)" : String, "[MembershipIdentifier](#cfn-cleanrooms-idmappingtable-membershipidentifier)" : String, "[Name](#cfn-cleanrooms-idmappingtable-name)" : String, "[Tags](#cfn-cleanrooms-idmappingtable-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::IdMappingTable Properties: [Description](#cfn-cleanrooms-idmappingtable-description): String [InputReferenceConfig](#cfn-cleanrooms-idmappingtable-inputreferenceconfig): IdMappingTableInputReferenceConfig [KmsKeyArn](#cfn-cleanrooms-idmappingtable-kmskeyarn): String [MembershipIdentifier](#cfn-cleanrooms-idmappingtable-membershipidentifier): String [Name](#cfn-cleanrooms-idmappingtable-name): String [Tags](#cfn-cleanrooms-idmappingtable-tags): - Tag ``` ## Properties `Description` The description of the ID mapping table. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputReferenceConfig` The input reference configuration for the ID mapping table. *Required*: Yes *Type*: [IdMappingTableInputReferenceConfig](aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KmsKeyArn` The Amazon Resource Name (ARN) of the AWS KMS key. *Required*: No *Type*: String *Minimum*: `4` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MembershipIdentifier` The unique identifier of the membership resource for the ID mapping table. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the ID mapping table. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-idmappingtable-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{"Ref": "MyIdMappingTable"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The Amazon Resource Name (ARN) of the ID mapping table. `CollaborationArn` The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table. `CollaborationIdentifier` The unique identifier of the collaboration that contains this ID mapping table. `IdMappingTableIdentifier` The unique identifier of the ID mapping table identifier that you want to retrieve. `MembershipArn` The Amazon Resource Name (ARN) of the membership resource for the ID mapping table. # AWS::CleanRooms::IdMappingTable IdMappingTableInputReferenceConfig Provides the input reference configuration for the ID mapping table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputReferenceArn](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-inputreferencearn)" : String, "[ManageResourcePolicies](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-manageresourcepolicies)" : Boolean } ``` ### YAML ``` [InputReferenceArn](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-inputreferencearn): String [ManageResourcePolicies](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-manageresourcepolicies): Boolean ``` ## Properties `InputReferenceArn` The Amazon Resource Name (ARN) of the referenced resource in AWS Entity Resolution. Valid values are ID mapping workflow ARNs. *Required*: Yes *Type*: String *Minimum*: `20` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ManageResourcePolicies` When `TRUE`, AWS Clean Rooms manages permissions for the ID mapping table resource. When `FALSE`, the resource owner manages permissions for the ID mapping table resource. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::IdMappingTable IdMappingTableInputReferenceProperties The input reference properties for the ID mapping table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdMappingTableInputSource](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties-idmappingtableinputsource)" : [ IdMappingTableInputSource, ... ] } ``` ### YAML ``` [IdMappingTableInputSource](#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties-idmappingtableinputsource): - IdMappingTableInputSource ``` ## Properties `IdMappingTableInputSource` The input source of the ID mapping table. *Required*: Yes *Type*: [Array](aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.md) of [IdMappingTableInputSource](aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.md) *Minimum*: `2` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdMappingTable IdMappingTableInputSource The input source of the ID mapping table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdNamespaceAssociationId](#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-idnamespaceassociationid)" : String, "[Type](#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-type)" : String } ``` ### YAML ``` [IdNamespaceAssociationId](#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-idnamespaceassociationid): String [Type](#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-type): String ``` ## Properties `IdNamespaceAssociationId` The unique identifier of the ID namespace association. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of the input source of the ID mapping table. *Required*: Yes *Type*: String *Allowed values*: `SOURCE | TARGET` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdMappingTable Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-idmappingtable-tag-key)" : String, "[Value](#cfn-cleanrooms-idmappingtable-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-idmappingtable-tag-key): String [Value](#cfn-cleanrooms-idmappingtable-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdNamespaceAssociation Provides information to create the ID namespace association. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::IdNamespaceAssociation", "Properties" : { "[Description](#cfn-cleanrooms-idnamespaceassociation-description)" : String, "[IdMappingConfig](#cfn-cleanrooms-idnamespaceassociation-idmappingconfig)" : IdMappingConfig, "[InputReferenceConfig](#cfn-cleanrooms-idnamespaceassociation-inputreferenceconfig)" : IdNamespaceAssociationInputReferenceConfig, "[MembershipIdentifier](#cfn-cleanrooms-idnamespaceassociation-membershipidentifier)" : String, "[Name](#cfn-cleanrooms-idnamespaceassociation-name)" : String, "[Tags](#cfn-cleanrooms-idnamespaceassociation-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::IdNamespaceAssociation Properties: [Description](#cfn-cleanrooms-idnamespaceassociation-description): String [IdMappingConfig](#cfn-cleanrooms-idnamespaceassociation-idmappingconfig): IdMappingConfig [InputReferenceConfig](#cfn-cleanrooms-idnamespaceassociation-inputreferenceconfig): IdNamespaceAssociationInputReferenceConfig [MembershipIdentifier](#cfn-cleanrooms-idnamespaceassociation-membershipidentifier): String [Name](#cfn-cleanrooms-idnamespaceassociation-name): String [Tags](#cfn-cleanrooms-idnamespaceassociation-tags): - Tag ``` ## Properties `Description` The description of the ID namespace association. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdMappingConfig` The configuration settings for the ID mapping table. *Required*: No *Type*: [IdMappingConfig](aws-properties-cleanrooms-idnamespaceassociation-idmappingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputReferenceConfig` The input reference configuration for the ID namespace association. *Required*: Yes *Type*: [IdNamespaceAssociationInputReferenceConfig](aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MembershipIdentifier` The unique identifier of the membership that contains the ID namespace association. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of this ID namespace association. *Required*: Yes *Type*: String *Pattern*: `^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-idnamespaceassociation-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{"Ref": "MyIdNamespaceAssociation"}` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The Amazon Resource Name (ARN) of the ID namespace association. `CollaborationArn` The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association. `CollaborationIdentifier` The unique identifier of the collaboration that contains this ID namespace association. `IdNamespaceAssociationIdentifier` The unique identifier of the ID namespace association that you want to retrieve. `MembershipArn` The Amazon Resource Name (ARN) of the membership resource for this ID namespace association. # AWS::CleanRooms::IdNamespaceAssociation IdMappingConfig The configuration settings for the ID mapping table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowUseAsDimensionColumn](#cfn-cleanrooms-idnamespaceassociation-idmappingconfig-allowuseasdimensioncolumn)" : Boolean } ``` ### YAML ``` [AllowUseAsDimensionColumn](#cfn-cleanrooms-idnamespaceassociation-idmappingconfig-allowuseasdimensioncolumn): Boolean ``` ## Properties `AllowUseAsDimensionColumn` An indicator as to whether you can use your column as a dimension column in the ID mapping table (`TRUE`) or not (`FALSE`). Default is `FALSE`. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdNamespaceAssociation IdNamespaceAssociationInputReferenceConfig Provides the information for the ID namespace association input reference configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputReferenceArn](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-inputreferencearn)" : String, "[ManageResourcePolicies](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-manageresourcepolicies)" : Boolean } ``` ### YAML ``` [InputReferenceArn](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-inputreferencearn): String [ManageResourcePolicies](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-manageresourcepolicies): Boolean ``` ## Properties `InputReferenceArn` The Amazon Resource Name (ARN) of the AWS Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own. *Required*: Yes *Type*: String *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ManageResourcePolicies` When `TRUE`, AWS Clean Rooms manages permissions for the ID namespace association resource. When `FALSE`, the resource owner manages permissions for the ID namespace association resource. *Required*: Yes *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CleanRooms::IdNamespaceAssociation IdNamespaceAssociationInputReferenceProperties Provides the information for the ID namespace association input reference properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdMappingWorkflowsSupported](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idmappingworkflowssupported)" : [ Json, ... ], "[IdNamespaceType](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idnamespacetype)" : String } ``` ### YAML ``` [IdMappingWorkflowsSupported](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idmappingworkflowssupported): - Json [IdNamespaceType](#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idnamespacetype): String ``` ## Properties `IdMappingWorkflowsSupported` Defines how ID mapping workflows are supported for this ID namespace association. *Required*: No *Type*: Array of Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdNamespaceType` The ID namespace type for this ID namespace association. *Required*: No *Type*: String *Allowed values*: `SOURCE | TARGET` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::IdNamespaceAssociation Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-idnamespaceassociation-tag-key)" : String, "[Value](#cfn-cleanrooms-idnamespaceassociation-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-idnamespaceassociation-tag-key): String [Value](#cfn-cleanrooms-idnamespaceassociation-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership Creates a membership for a specific collaboration identifier and joins the collaboration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::Membership", "Properties" : { "[CollaborationIdentifier](#cfn-cleanrooms-membership-collaborationidentifier)" : String, "[DefaultJobResultConfiguration](#cfn-cleanrooms-membership-defaultjobresultconfiguration)" : MembershipProtectedJobResultConfiguration, "[DefaultResultConfiguration](#cfn-cleanrooms-membership-defaultresultconfiguration)" : MembershipProtectedQueryResultConfiguration, "[IsMetricsEnabled](#cfn-cleanrooms-membership-ismetricsenabled)" : Boolean, "[JobLogStatus](#cfn-cleanrooms-membership-joblogstatus)" : String, "[PaymentConfiguration](#cfn-cleanrooms-membership-paymentconfiguration)" : MembershipPaymentConfiguration, "[QueryLogStatus](#cfn-cleanrooms-membership-querylogstatus)" : String, "[Tags](#cfn-cleanrooms-membership-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::Membership Properties: [CollaborationIdentifier](#cfn-cleanrooms-membership-collaborationidentifier): String [DefaultJobResultConfiguration](#cfn-cleanrooms-membership-defaultjobresultconfiguration): MembershipProtectedJobResultConfiguration [DefaultResultConfiguration](#cfn-cleanrooms-membership-defaultresultconfiguration): MembershipProtectedQueryResultConfiguration [IsMetricsEnabled](#cfn-cleanrooms-membership-ismetricsenabled): Boolean [JobLogStatus](#cfn-cleanrooms-membership-joblogstatus): String [PaymentConfiguration](#cfn-cleanrooms-membership-paymentconfiguration): MembershipPaymentConfiguration [QueryLogStatus](#cfn-cleanrooms-membership-querylogstatus): String [Tags](#cfn-cleanrooms-membership-tags): - Tag ``` ## Properties `CollaborationIdentifier` The unique ID for the associated collaboration. *Required*: Yes *Type*: String *Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DefaultJobResultConfiguration` The default job result configuration for the membership. *Required*: No *Type*: [MembershipProtectedJobResultConfiguration](aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultResultConfiguration` The default protected query result configuration as specified by the member who can receive results. *Required*: No *Type*: [MembershipProtectedQueryResultConfiguration](aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsMetricsEnabled` An indicator as to whether Amazon CloudWatch metrics are enabled for the membership. When `true`, metrics about query execution are collected in Amazon CloudWatch. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JobLogStatus` 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`. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PaymentConfiguration` The payment responsibilities accepted by the collaboration member. *Required*: No *Type*: [MembershipPaymentConfiguration](aws-properties-cleanrooms-membership-membershippaymentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryLogStatus` 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`. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-membership-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `MembershipId`, such as `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. For example: `{ "Ref": "MyMembership" }` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` Returns the Amazon Resource Name (ARN) of the specified membership. Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` `CollaborationArn` Returns the Amazon Resource Name (ARN) of the specified collaboration. Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` `CollaborationCreatorAccountId` Returns the unique identifier of the specified collaboration creator account. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` `MembershipIdentifier` Returns the unique identifier of the specified membership. Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` ## Remarks If you are a collaboration owner, ensure that you add `"DeletionPolicy: Retain"` and `"UpdateReplacePolicy: Retain"` to the `Membership` resource in your CloudFormation template. If your `Membership` resource depends on the collaboration explicitly or implicitly by using a `"Ref"` on the `Collaboration` (`CollaborationIdentifier: !Ref Collaboration`), CloudFormation tries to delete the `Membership` resource before the `Collaboration` resource. However, this attempt will fail because collaboration owners must delete the collaboration before deleting their membership to the collaboration. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). ## Examples **Topics** + [Membership for a collaboration creator](#aws-resource-cleanrooms-membership--examples--Membership_for_a_collaboration_creator) + [Membership for a non-collaboration creator](#aws-resource-cleanrooms-membership--examples--Membership_for_a_non-collaboration_creator) ### Membership for a collaboration creator The following an example of a membership for a collaboration creator. See the Remarks section for notes on the use of the deletion and update replacement policies. #### JSON ``` "CollaborationCreatorMembership": { "Type" : "AWS::CleanRooms::Membership", "DeletionPolicy": "Retain", "UpdateReplacePolicy": "Retain", "Properties" : { "CollaborationIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "QueryLogStatus" : "ENABLED", } } ``` #### YAML ``` CollaborationCreatorMembership: Type: AWS::CleanRooms::Membership DeletionPolicy: Retain UpdateReplacePolicy: Retain Properties: CollaborationIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 QueryLogStatus: ENABLED ``` ### Membership for a non-collaboration creator The following is an example of a membership for a non-collaboration creator. #### JSON ``` "ExampleMembership": { "Type" : "AWS::CleanRooms::Membership", "Properties" : { "CollaborationIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "QueryLogStatus" : "ENABLED", } } ``` #### YAML ``` ExampleMembership: Type: AWS::CleanRooms::Membership Properties: CollaborationIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 QueryLogStatus: ENABLED ``` # AWS::CleanRooms::Membership MembershipJobComputePaymentConfig An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-membership-membershipjobcomputepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-membership-membershipjobcomputepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration member has accepted to pay for job compute costs (`TRUE`) or has not accepted to pay for query and job compute costs (`FALSE`). There is only one member who pays for queries and jobs. An error message is returned for the following reasons: + If you set the value to `FALSE` but you are responsible to pay for query and job compute costs. + If you set the value to `TRUE` but you are not responsible to pay for query and job compute costs. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipMLPaymentConfig An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelInference](#cfn-cleanrooms-membership-membershipmlpaymentconfig-modelinference)" : MembershipModelInferencePaymentConfig, "[ModelTraining](#cfn-cleanrooms-membership-membershipmlpaymentconfig-modeltraining)" : MembershipModelTrainingPaymentConfig, "[SyntheticDataGeneration](#cfn-cleanrooms-membership-membershipmlpaymentconfig-syntheticdatageneration)" : MembershipSyntheticDataGenerationPaymentConfig } ``` ### YAML ``` [ModelInference](#cfn-cleanrooms-membership-membershipmlpaymentconfig-modelinference): MembershipModelInferencePaymentConfig [ModelTraining](#cfn-cleanrooms-membership-membershipmlpaymentconfig-modeltraining): MembershipModelTrainingPaymentConfig [SyntheticDataGeneration](#cfn-cleanrooms-membership-membershipmlpaymentconfig-syntheticdatageneration): MembershipSyntheticDataGenerationPaymentConfig ``` ## Properties `ModelInference` The payment responsibilities accepted by the member for model inference. *Required*: No *Type*: [MembershipModelInferencePaymentConfig](aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelTraining` The payment responsibilities accepted by the member for model training. *Required*: No *Type*: [MembershipModelTrainingPaymentConfig](aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SyntheticDataGeneration` The payment configuration for synthetic data generation for this machine learning membership. *Required*: No *Type*: [MembershipSyntheticDataGenerationPaymentConfig](aws-properties-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipModelInferencePaymentConfig An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-membership-membershipmodelinferencepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-membership-membershipmodelinferencepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration member has accepted to pay for model inference costs (`TRUE`) or has not accepted to pay for model inference costs (`FALSE`). If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. An error message is returned for the following reasons: + If you set the value to `FALSE` but you are responsible to pay for model inference costs. + If you set the value to `TRUE` but you are not responsible to pay for model inference costs. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipModelTrainingPaymentConfig An object representing the collaboration member's model training payment responsibilities set by the collaboration creator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-membership-membershipmodeltrainingpaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-membership-membershipmodeltrainingpaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration member has accepted to pay for model training costs (`TRUE`) or has not accepted to pay for model training costs (`FALSE`). If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. An error message is returned for the following reasons: + If you set the value to `FALSE` but you are responsible to pay for model training costs. + If you set the value to `TRUE` but you are not responsible to pay for model training costs. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipPaymentConfiguration An object representing the payment responsibilities accepted by the collaboration member. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[JobCompute](#cfn-cleanrooms-membership-membershippaymentconfiguration-jobcompute)" : MembershipJobComputePaymentConfig, "[MachineLearning](#cfn-cleanrooms-membership-membershippaymentconfiguration-machinelearning)" : MembershipMLPaymentConfig, "[QueryCompute](#cfn-cleanrooms-membership-membershippaymentconfiguration-querycompute)" : MembershipQueryComputePaymentConfig } ``` ### YAML ``` [JobCompute](#cfn-cleanrooms-membership-membershippaymentconfiguration-jobcompute): MembershipJobComputePaymentConfig [MachineLearning](#cfn-cleanrooms-membership-membershippaymentconfiguration-machinelearning): MembershipMLPaymentConfig [QueryCompute](#cfn-cleanrooms-membership-membershippaymentconfiguration-querycompute): MembershipQueryComputePaymentConfig ``` ## Properties `JobCompute` The payment responsibilities accepted by the collaboration member for job compute costs. *Required*: No *Type*: [MembershipJobComputePaymentConfig](aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MachineLearning` The payment responsibilities accepted by the collaboration member for machine learning costs. *Required*: No *Type*: [MembershipMLPaymentConfig](aws-properties-cleanrooms-membership-membershipmlpaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryCompute` The payment responsibilities accepted by the collaboration member for query compute costs. *Required*: Yes *Type*: [MembershipQueryComputePaymentConfig](aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipProtectedJobOutputConfiguration Contains configurations for protected job results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-cleanrooms-membership-membershipprotectedjoboutputconfiguration-s3)" : ProtectedJobS3OutputConfigurationInput } ``` ### YAML ``` [S3](#cfn-cleanrooms-membership-membershipprotectedjoboutputconfiguration-s3): ProtectedJobS3OutputConfigurationInput ``` ## Properties `S3` Contains the configuration to write the job results to S3. *Required*: Yes *Type*: [ProtectedJobS3OutputConfigurationInput](aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipProtectedJobResultConfiguration Contains configurations for protected job results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OutputConfiguration](#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-outputconfiguration)" : MembershipProtectedJobOutputConfiguration, "[RoleArn](#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-rolearn)" : String } ``` ### YAML ``` [OutputConfiguration](#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-outputconfiguration): MembershipProtectedJobOutputConfiguration [RoleArn](#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-rolearn): String ``` ## Properties `OutputConfiguration` The output configuration for a protected job result. *Required*: Yes *Type*: [MembershipProtectedJobOutputConfiguration](aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected job results to the result location, given by the member who can receive results. *Required*: Yes *Type*: String *Minimum*: `32` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipProtectedQueryOutputConfiguration Contains configurations for protected query results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-cleanrooms-membership-membershipprotectedqueryoutputconfiguration-s3)" : ProtectedQueryS3OutputConfiguration } ``` ### YAML ``` [S3](#cfn-cleanrooms-membership-membershipprotectedqueryoutputconfiguration-s3): ProtectedQueryS3OutputConfiguration ``` ## Properties `S3` Required configuration for a protected query with an `s3` output type. *Required*: Yes *Type*: [ProtectedQueryS3OutputConfiguration](aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipProtectedQueryResultConfiguration Contains configurations for protected query results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OutputConfiguration](#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-outputconfiguration)" : MembershipProtectedQueryOutputConfiguration, "[RoleArn](#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-rolearn)" : String } ``` ### YAML ``` [OutputConfiguration](#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-outputconfiguration): MembershipProtectedQueryOutputConfiguration [RoleArn](#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-rolearn): String ``` ## Properties `OutputConfiguration` Configuration for protected query results. *Required*: Yes *Type*: [MembershipProtectedQueryOutputConfiguration](aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results. *Required*: No *Type*: String *Minimum*: `32` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipQueryComputePaymentConfig An object representing the payment responsibilities accepted by the collaboration member for query compute costs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-membership-membershipquerycomputepaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-membership-membershipquerycomputepaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates whether the collaboration member has accepted to pay for query compute costs (`TRUE`) or has not accepted to pay for query compute costs (`FALSE`). If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. An error message is returned for the following reasons: + If you set the value to `FALSE` but you are responsible to pay for query compute costs. + If you set the value to `TRUE` but you are not responsible to pay for query compute costs. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership MembershipSyntheticDataGenerationPaymentConfig Configuration for payment for synthetic data generation in a membership. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsResponsible](#cfn-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig-isresponsible)" : Boolean } ``` ### YAML ``` [IsResponsible](#cfn-cleanrooms-membership-membershipsyntheticdatagenerationpaymentconfig-isresponsible): Boolean ``` ## Properties `IsResponsible` Indicates if this membership is responsible for paying for synthetic data generation. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership ProtectedJobS3OutputConfigurationInput Contains input information for protected jobs with an S3 output type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-bucket)" : String, "[KeyPrefix](#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-keyprefix)" : String } ``` ### YAML ``` [Bucket](#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-bucket): String [KeyPrefix](#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-keyprefix): String ``` ## Properties `Bucket` The S3 bucket for job output. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KeyPrefix` The S3 prefix to unload the protected job results. *Required*: No *Type*: String *Pattern*: `[\w!.=*/-]*` *Minimum*: `0` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership ProtectedQueryS3OutputConfiguration Contains the configuration to write the query results to S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-bucket)" : String, "[KeyPrefix](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-keyprefix)" : String, "[ResultFormat](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-resultformat)" : String, "[SingleFileOutput](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-singlefileoutput)" : Boolean } ``` ### YAML ``` [Bucket](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-bucket): String [KeyPrefix](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-keyprefix): String [ResultFormat](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-resultformat): String [SingleFileOutput](#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-singlefileoutput): Boolean ``` ## Properties `Bucket` The S3 bucket to unload the protected query results. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KeyPrefix` The S3 prefix to unload the protected query results. *Required*: No *Type*: String *Pattern*: `[\w!.=*/-]*` *Minimum*: `0` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResultFormat` Intended file format of the result. *Required*: Yes *Type*: String *Allowed values*: `CSV | PARQUET` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SingleFileOutput` Indicates whether files should be output as a single file (`TRUE`) or output as multiple files (`FALSE`). This parameter is only supported for analyses with the Spark analytics engine. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::Membership Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-membership-tag-key)" : String, "[Value](#cfn-cleanrooms-membership-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-membership-tag-key): String [Value](#cfn-cleanrooms-membership-tag-value): String ``` ## Properties `Key` The key of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::PrivacyBudgetTemplate An object that defines the privacy budget template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CleanRooms::PrivacyBudgetTemplate", "Properties" : { "[AutoRefresh](#cfn-cleanrooms-privacybudgettemplate-autorefresh)" : String, "[MembershipIdentifier](#cfn-cleanrooms-privacybudgettemplate-membershipidentifier)" : String, "[Parameters](#cfn-cleanrooms-privacybudgettemplate-parameters)" : Parameters, "[PrivacyBudgetType](#cfn-cleanrooms-privacybudgettemplate-privacybudgettype)" : String, "[Tags](#cfn-cleanrooms-privacybudgettemplate-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CleanRooms::PrivacyBudgetTemplate Properties: [AutoRefresh](#cfn-cleanrooms-privacybudgettemplate-autorefresh): String [MembershipIdentifier](#cfn-cleanrooms-privacybudgettemplate-membershipidentifier): String [Parameters](#cfn-cleanrooms-privacybudgettemplate-parameters): Parameters [PrivacyBudgetType](#cfn-cleanrooms-privacybudgettemplate-privacybudgettype): String [Tags](#cfn-cleanrooms-privacybudgettemplate-tags): - Tag ``` ## Properties `AutoRefresh` 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. *Required*: Yes *Type*: String *Allowed values*: `CALENDAR_MONTH | NONE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MembershipIdentifier` The identifier for a membership resource. *Required*: Yes *Type*: String *Pattern*: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` *Minimum*: `36` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Parameters` Specifies the epsilon and noise parameters for the privacy budget template. *Required*: Yes *Type*: [Parameters](aws-properties-cleanrooms-privacybudgettemplate-parameters.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrivacyBudgetType` Specifies the type of the privacy budget template. *Required*: Yes *Type*: String *Allowed values*: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-cleanrooms-privacybudgettemplate-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource ARN. For example: `{ "Ref": "myPrivacyBudgetTemplate" }` For the Clean Rooms privacy budget template, `Ref` returns the ARN of the privacy budget template. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The ARN of the privacy budget template. `CollaborationArn` The ARN of the collaboration that contains this privacy budget template. `CollaborationIdentifier` The unique ID of the collaboration that contains this privacy budget template. `MembershipArn` The Amazon Resource Name (ARN) of the member who created the privacy budget template. `PrivacyBudgetTemplateIdentifier` A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID. # AWS::CleanRooms::PrivacyBudgetTemplate BudgetParameter Individual budget parameter configuration that defines specific budget allocation settings for access budgets. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AutoRefresh](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-autorefresh)" : String, "[Budget](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-budget)" : Integer, "[Type](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-type)" : String } ``` ### YAML ``` [AutoRefresh](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-autorefresh): String [Budget](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-budget): Integer [Type](#cfn-cleanrooms-privacybudgettemplate-budgetparameter-type): String ``` ## Properties `AutoRefresh` Whether this individual budget parameter automatically refreshes when the budget period resets. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Budget` The budget allocation amount for this specific parameter. *Required*: Yes *Type*: Integer *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of budget parameter being configured. *Required*: Yes *Type*: String *Allowed values*: `CALENDAR_DAY | CALENDAR_MONTH | CALENDAR_WEEK | LIFETIME` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::PrivacyBudgetTemplate Parameters Specifies the epsilon and noise parameters for the privacy budget template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BudgetParameters](#cfn-cleanrooms-privacybudgettemplate-parameters-budgetparameters)" : [ BudgetParameter, ... ], "[Epsilon](#cfn-cleanrooms-privacybudgettemplate-parameters-epsilon)" : Integer, "[ResourceArn](#cfn-cleanrooms-privacybudgettemplate-parameters-resourcearn)" : String, "[UsersNoisePerQuery](#cfn-cleanrooms-privacybudgettemplate-parameters-usersnoiseperquery)" : Integer } ``` ### YAML ``` [BudgetParameters](#cfn-cleanrooms-privacybudgettemplate-parameters-budgetparameters): - BudgetParameter [Epsilon](#cfn-cleanrooms-privacybudgettemplate-parameters-epsilon): Integer [ResourceArn](#cfn-cleanrooms-privacybudgettemplate-parameters-resourcearn): String [UsersNoisePerQuery](#cfn-cleanrooms-privacybudgettemplate-parameters-usersnoiseperquery): Integer ``` ## Properties `BudgetParameters` Property description not available. *Required*: No *Type*: Array of [BudgetParameter](aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.md) *Minimum*: `1` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Epsilon` The epsilon value that you want to use. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceArn` Property description not available. *Required*: No *Type*: String *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UsersNoisePerQuery` Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted. *Required*: No *Type*: Integer *Minimum*: `10` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CleanRooms::PrivacyBudgetTemplate Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cleanrooms-privacybudgettemplate-tag-key)" : String, "[Value](#cfn-cleanrooms-privacybudgettemplate-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cleanrooms-privacybudgettemplate-tag-key): String [Value](#cfn-cleanrooms-privacybudgettemplate-tag-value): String ``` ## Properties `Key` The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)