AWS::CleanRooms::AnalysisTemplate

CleanRooms AnalysisTemplate

Represents a stored analysis within a collaboration

Properties

11 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`Format`	`string`	RequiredCreate-only
`MembershipIdentifier`	`string`	RequiredCreate-only
`Name`	`string`	RequiredCreate-only
`Source`	`AnalysisSource`	RequiredCreate-only
`AnalysisParameters`	`Array<AnalysisParameter>`	Create-only
`Description`	`string`
`ErrorMessageConfiguration`	`ErrorMessageConfiguration`	Create-only
`Schema`	`AnalysisSchema`	Create-only
`SourceMetadata`	`AnalysisSourceMetadata`
`SyntheticDataParameters`	`SyntheticDataParameters`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AnalysisTemplateIdentifier`	`string`	-
`Arn`	`string`	-
`CollaborationArn`	`string`	-
`CollaborationIdentifier`	`string`	-
`MembershipArn`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CleanRooms::AnalysisTemplate

Resources:
  MyResource:
    Type: AWS::CleanRooms::AnalysisTemplate
    Properties:
      Source: "value"
      Format: "SQL"
      Name: "my-name"
      MembershipIdentifier: "my-membershipidentifier"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cleanrooms:CreateAnalysisTemplatecleanrooms:ListTagsForResourcecleanrooms:TagResourcecleanrooms:GetAnalysisTemplatecleanrooms:ListAnalysisTemplatesiam:PassRole

read

cleanrooms:GetAnalysisTemplatecleanrooms:ListTagsForResource

update

cleanrooms:UpdateAnalysisTemplatecleanrooms:GetAnalysisTemplatecleanrooms:ListTagsForResourcecleanrooms:TagResourcecleanrooms:UntagResource

delete

cleanrooms:DeleteAnalysisTemplatecleanrooms:GetAnalysisTemplatecleanrooms:ListAnalysisTemplatescleanrooms:ListTagsForResourcecleanrooms:UntagResource

list

cleanrooms:ListAnalysisTemplates

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCleanRooms

Properties16

Required4

TaggingSupported

Primary IDAnalysisTemplateIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameMembershipIdentifierSourceFormatAnalysisParametersSchemaErrorMessageConfigurationSyntheticDataParameters

Related Resources

External Links

AWS Documentation