Package software.amazon.awscdk.services.cleanrooms

Class CfnAnalysisTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanrooms.CfnAnalysisTemplate
All Implemented Interfaces:
IInspectable, IAnalysisTemplateRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:31.412Z") @Stability(Stable) public class CfnAnalysisTemplate extends CfnResource implements IInspectable, IAnalysisTemplateRef, ITaggableV2
Creates a new analysis template.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cleanrooms.*;
 CfnAnalysisTemplate cfnAnalysisTemplate = CfnAnalysisTemplate.Builder.create(this, "MyCfnAnalysisTemplate")
         .format("format")
         .membershipIdentifier("membershipIdentifier")
         .name("name")
         .source(AnalysisSourceProperty.builder()
                 .artifacts(AnalysisTemplateArtifactsProperty.builder()
                         .entryPoint(AnalysisTemplateArtifactProperty.builder()
                                 .location(S3LocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build())
                         .roleArn("roleArn")
                         // the properties below are optional
                         .additionalArtifacts(List.of(AnalysisTemplateArtifactProperty.builder()
                                 .location(S3LocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build()))
                         .build())
                 .text("text")
                 .build())
         // the properties below are optional
         .analysisParameters(List.of(AnalysisParameterProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .defaultValue("defaultValue")
                 .build()))
         .description("description")
         .errorMessageConfiguration(ErrorMessageConfigurationProperty.builder()
                 .type("type")
                 .build())
         .schema(AnalysisSchemaProperty.builder()
                 .referencedTables(List.of("referencedTables"))
                 .build())
         .sourceMetadata(AnalysisSourceMetadataProperty.builder()
                 .artifacts(AnalysisTemplateArtifactMetadataProperty.builder()
                         .entryPointHash(HashProperty.builder()
                                 .sha256("sha256")
                                 .build())
                         // the properties below are optional
                         .additionalArtifactHashes(List.of(HashProperty.builder()
                                 .sha256("sha256")
                                 .build()))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAnalysisTemplate

      protected CfnAnalysisTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAnalysisTemplate

      protected CfnAnalysisTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAnalysisTemplate

      @Stability(Stable) public CfnAnalysisTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnalysisTemplateProps props)
      Create a new AWS::CleanRooms::AnalysisTemplate.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAnalysisTemplate

      @Stability(Stable) @NotNull public static String arnForAnalysisTemplate(@NotNull IAnalysisTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAnalysisTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnAnalysisTemplate(@NotNull Object x)
      Checks whether the given object is a CfnAnalysisTemplate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAnalysisTemplateRef

      @Stability(Stable) @NotNull public AnalysisTemplateReference getAnalysisTemplateRef()
      A reference to a AnalysisTemplate resource.
      Specified by:
      getAnalysisTemplateRef in interface IAnalysisTemplateRef

    • getAttrAnalysisTemplateIdentifier

      @Stability(Stable) @NotNull public String getAttrAnalysisTemplateIdentifier()
      Returns the identifier for the analysis template.

      Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      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

    • getAttrCollaborationArn

      @Stability(Stable) @NotNull public String getAttrCollaborationArn()
      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

    • getAttrCollaborationIdentifier

      @Stability(Stable) @NotNull public String getAttrCollaborationIdentifier()
      Returns the unique ID for the associated collaboration of the analysis template.

      Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    • getAttrMembershipArn

      @Stability(Stable) @NotNull public String getAttrMembershipArn()
      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

    • getAttrSchema

      @Stability(Stable) @NotNull public IResolvable getAttrSchema()

    • getAttrSchemaReferencedTables

      @Stability(Stable) @NotNull public List<String> getAttrSchemaReferencedTables()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFormat

      @Stability(Stable) @NotNull public String getFormat()
      The format of the analysis template.

    • setFormat

      @Stability(Stable) public void setFormat(@NotNull String value)
      The format of the analysis template.

    • getMembershipIdentifier

      @Stability(Stable) @NotNull public String getMembershipIdentifier()
      The identifier for a membership resource.

    • setMembershipIdentifier

      @Stability(Stable) public void setMembershipIdentifier(@NotNull String value)
      The identifier for a membership resource.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the analysis template.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the analysis template.

    • getSource

      @Stability(Stable) @NotNull public Object getSource()
      The source of the analysis template.

      Returns union: either IResolvable or CfnAnalysisTemplate.AnalysisSourceProperty

    • setSource

      @Stability(Stable) public void setSource(@NotNull IResolvable value)
      The source of the analysis template.

    • setSource

      @Stability(Stable) public void setSource(@NotNull CfnAnalysisTemplate.AnalysisSourceProperty value)
      The source of the analysis template.

    • getAnalysisParameters

      @Stability(Stable) @Nullable public Object getAnalysisParameters()
      The parameters of the analysis template.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysisTemplate.AnalysisParameterProperty>

    • setAnalysisParameters

      @Stability(Stable) public void setAnalysisParameters(@Nullable IResolvable value)
      The parameters of the analysis template.

    • setAnalysisParameters

      @Stability(Stable) public void setAnalysisParameters(@Nullable List<Object> value)
      The parameters of the analysis template.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the analysis template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the analysis template.

    • getErrorMessageConfiguration

      @Stability(Stable) @Nullable public Object getErrorMessageConfiguration()
      The configuration that specifies the level of detail in error messages returned by analyses using this template.

      Returns union: either IResolvable or CfnAnalysisTemplate.ErrorMessageConfigurationProperty

    • setErrorMessageConfiguration

      @Stability(Stable) public void setErrorMessageConfiguration(@Nullable IResolvable value)
      The configuration that specifies the level of detail in error messages returned by analyses using this template.

    • setErrorMessageConfiguration

      @Stability(Stable) public void setErrorMessageConfiguration(@Nullable CfnAnalysisTemplate.ErrorMessageConfigurationProperty value)
      The configuration that specifies the level of detail in error messages returned by analyses using this template.

    • getSchema

      @Stability(Stable) @Nullable public Object getSchema()
      The entire schema object.

      Returns union: either IResolvable or CfnAnalysisTemplate.AnalysisSchemaProperty

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable IResolvable value)
      The entire schema object.

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable CfnAnalysisTemplate.AnalysisSchemaProperty value)
      The entire schema object.

    • getSourceMetadata

      @Stability(Stable) @Nullable public Object getSourceMetadata()
      The source metadata for the analysis template.

      Returns union: either IResolvable or CfnAnalysisTemplate.AnalysisSourceMetadataProperty

    • setSourceMetadata

      @Stability(Stable) public void setSourceMetadata(@Nullable IResolvable value)
      The source metadata for the analysis template.

    • setSourceMetadata

      @Stability(Stable) public void setSourceMetadata(@Nullable CfnAnalysisTemplate.AnalysisSourceMetadataProperty value)
      The source metadata for the analysis template.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An optional label that you can assign to a resource when you create it.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An optional label that you can assign to a resource when you create it.