CfnAnalysisTemplateProps

class aws_cdk.aws_cleanrooms.CfnAnalysisTemplateProps(*, format, membership_identifier, name, source, analysis_parameters=None, description=None, error_message_configuration=None, schema=None, source_metadata=None, tags=None)

Bases: object

Properties for defining a CfnAnalysisTemplate.

Parameters:

format (str) – The format of the analysis template.
membership_identifier (str) – The identifier for a membership resource.
name (str) – The name of the analysis template.
source (Union[IResolvable, AnalysisSourceProperty, Dict[str, Any]]) – The source of the analysis template.
analysis_parameters (Union[IResolvable, Sequence[Union[IResolvable, AnalysisParameterProperty, Dict[str, Any]]], None]) – The parameters of the analysis template.
description (Optional[str]) – The description of the analysis template.
error_message_configuration (Union[IResolvable, ErrorMessageConfigurationProperty, Dict[str, Any], None]) – 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.
schema (Union[IResolvable, AnalysisSchemaProperty, Dict[str, Any], None]) – The entire schema object.
source_metadata (Union[IResolvable, AnalysisSourceMetadataProperty, Dict[str, Any], None]) – The source metadata for the analysis template.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cleanrooms as cleanrooms

cfn_analysis_template_props = cleanrooms.CfnAnalysisTemplateProps(
    format="format",
    membership_identifier="membershipIdentifier",
    name="name",
    source=cleanrooms.CfnAnalysisTemplate.AnalysisSourceProperty(
        artifacts=cleanrooms.CfnAnalysisTemplate.AnalysisTemplateArtifactsProperty(
            entry_point=cleanrooms.CfnAnalysisTemplate.AnalysisTemplateArtifactProperty(
                location=cleanrooms.CfnAnalysisTemplate.S3LocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            role_arn="roleArn",

            # the properties below are optional
            additional_artifacts=[cleanrooms.CfnAnalysisTemplate.AnalysisTemplateArtifactProperty(
                location=cleanrooms.CfnAnalysisTemplate.S3LocationProperty(
                    bucket="bucket",
                    key="key"
                )
            )]
        ),
        text="text"
    ),

    # the properties below are optional
    analysis_parameters=[cleanrooms.CfnAnalysisTemplate.AnalysisParameterProperty(
        name="name",
        type="type",

        # the properties below are optional
        default_value="defaultValue"
    )],
    description="description",
    error_message_configuration=cleanrooms.CfnAnalysisTemplate.ErrorMessageConfigurationProperty(
        type="type"
    ),
    schema=cleanrooms.CfnAnalysisTemplate.AnalysisSchemaProperty(
        referenced_tables=["referencedTables"]
    ),
    source_metadata=cleanrooms.CfnAnalysisTemplate.AnalysisSourceMetadataProperty(
        artifacts=cleanrooms.CfnAnalysisTemplate.AnalysisTemplateArtifactMetadataProperty(
            entry_point_hash=cleanrooms.CfnAnalysisTemplate.HashProperty(
                sha256="sha256"
            ),

            # the properties below are optional
            additional_artifact_hashes=[cleanrooms.CfnAnalysisTemplate.HashProperty(
                sha256="sha256"
            )]
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

analysis_parameters

The parameters of the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters

description

The description of the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description

error_message_configuration

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration

format

The format of the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format

membership_identifier

The identifier for a membership resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier

name

The name of the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name

schema

The entire schema object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-schema

source

The source of the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source

source_metadata

The source metadata for the analysis template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-sourcemetadata

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags