interface CfnAnalysisTemplateMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CleanRooms.Mixins.CfnAnalysisTemplateMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscleanrooms/mixins#CfnAnalysisTemplateMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cleanrooms.mixins.CfnAnalysisTemplateMixinProps
Python	aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnAnalysisTemplateMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cleanrooms » mixins » CfnAnalysisTemplateMixinProps

Properties for CfnAnalysisTemplatePropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cleanrooms_mixins } from '@aws-cdk/mixins-preview/aws-cleanrooms';
const cfnAnalysisTemplateMixinProps: cleanrooms_mixins.CfnAnalysisTemplateMixinProps = {
  analysisParameters: [{
    defaultValue: 'defaultValue',
    name: 'name',
    type: 'type',
  }],
  description: 'description',
  errorMessageConfiguration: {
    type: 'type',
  },
  format: 'format',
  membershipIdentifier: 'membershipIdentifier',
  name: 'name',
  schema: {
    referencedTables: ['referencedTables'],
  },
  source: {
    artifacts: {
      additionalArtifacts: [{
        location: {
          bucket: 'bucket',
          key: 'key',
        },
      }],
      entryPoint: {
        location: {
          bucket: 'bucket',
          key: 'key',
        },
      },
      roleArn: 'roleArn',
    },
    text: 'text',
  },
  sourceMetadata: {
    artifacts: {
      additionalArtifactHashes: [{
        sha256: 'sha256',
      }],
      entryPointHash: {
        sha256: 'sha256',
      },
    },
  },
  syntheticDataParameters: {
    mlSyntheticDataParameters: {
      columnClassification: {
        columnMapping: [{
          columnName: 'columnName',
          columnType: 'columnType',
          isPredictiveValue: false,
        }],
      },
      epsilon: 123,
      maxMembershipInferenceAttackScore: 123,
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
analysisParameters?	IResolvable | (IResolvable | AnalysisParameterProperty)[]	The parameters of the analysis template.
description?	string	The description of the analysis template.
errorMessageConfiguration?	IResolvable | ErrorMessageConfigurationProperty	The configuration that specifies the level of detail in error messages returned by analyses using this template.
format?	string	The format of the analysis template.
membershipIdentifier?	string	The identifier for a membership resource.
name?	string	The name of the analysis template.
schema?	IResolvable | AnalysisSchemaProperty	The entire schema object.
source?	IResolvable | AnalysisSourceProperty	The source of the analysis template.
sourceMetadata?	IResolvable | AnalysisSourceMetadataProperty	The source metadata for the analysis template.
syntheticDataParameters?	IResolvable | SyntheticDataParametersProperty	The parameters used to generate synthetic data for this analysis template.
tags?	CfnTag[]	An optional label that you can assign to a resource when you create it.

---

analysisParameters?

Type: IResolvable | (IResolvable | AnalysisParameterProperty)[] (optional)

The parameters of the analysis template.

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

---

description?

Type: string (optional)

The description of the analysis template.

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

---

errorMessageConfiguration?

Type: IResolvable | ErrorMessageConfigurationProperty (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-errormessageconfiguration

---

format?

Type: string (optional)

The format of the analysis template.

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

---

membershipIdentifier?

Type: string (optional)

The identifier for a membership resource.

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

---

name?

Type: string (optional)

The name of the analysis template.

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

---

schema?

Type: IResolvable | AnalysisSchemaProperty (optional)

The entire schema object.

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

---

source?

Type: IResolvable | AnalysisSourceProperty (optional)

The source of the analysis template.

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

---

sourceMetadata?

Type: IResolvable | AnalysisSourceMetadataProperty (optional)

The source metadata for the analysis template.

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

---

syntheticDataParameters?

Type: IResolvable | SyntheticDataParametersProperty (optional)

The parameters used to generate synthetic data for this analysis template.

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

---

tags?

Type: CfnTag[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags