CfnAnalysisTemplatePropsMixin

class aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnAnalysisTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new analysis template.

See:

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

CloudformationResource:

AWS::CleanRooms::AnalysisTemplate

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_analysis_template_props_mixin = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin(cleanrooms_mixins.CfnAnalysisTemplateMixinProps(
    analysis_parameters=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisParameterProperty(
        default_value="defaultValue",
        name="name",
        type="type"
    )],
    description="description",
    error_message_configuration=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ErrorMessageConfigurationProperty(
        type="type"
    ),
    format="format",
    membership_identifier="membershipIdentifier",
    name="name",
    schema=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSchemaProperty(
        referenced_tables=["referencedTables"]
    ),
    source=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSourceProperty(
        artifacts=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactsProperty(
            additional_artifacts=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
                location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
                    bucket="bucket",
                    key="key"
                )
            )],
            entry_point=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
                location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            role_arn="roleArn"
        ),
        text="text"
    ),
    source_metadata=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSourceMetadataProperty(
        artifacts=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactMetadataProperty(
            additional_artifact_hashes=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
                sha256="sha256"
            )],
            entry_point_hash=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
                sha256="sha256"
            )
        )
    ),
    synthetic_data_parameters=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataParametersProperty(
        ml_synthetic_data_parameters=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.MLSyntheticDataParametersProperty(
            column_classification=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ColumnClassificationDetailsProperty(
                column_mapping=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(
                    column_name="columnName",
                    column_type="columnType",
                    is_predictive_value=False
                )]
            ),
            epsilon=123,
            max_membership_inference_attack_score=123
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CleanRooms::AnalysisTemplate.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['analysisParameters', 'description', 'errorMessageConfiguration', 'format', 'membershipIdentifier', 'name', 'schema', 'source', 'sourceMetadata', 'syntheticDataParameters', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AnalysisParameterProperty

class CfnAnalysisTemplatePropsMixin.AnalysisParameterProperty(*, default_value=None, name=None, type=None)

Bases: object

Optional.

The member who can query can provide this placeholder for a literal data value in an analysis template.

Parameters:

  • default_value (Optional[str]) – Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

  • name (Optional[str]) – The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

  • type (Optional[str]) – The type of parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_parameter_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisParameterProperty(
    default_value="defaultValue",
    name="name",
    type="type"
)

Attributes

default_value

Optional.

The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue

name

The name of the parameter.

The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

See:

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

type

The type of parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-type

AnalysisSchemaProperty

class CfnAnalysisTemplatePropsMixin.AnalysisSchemaProperty(*, referenced_tables=None)

Bases: object

A relation within an analysis.

Parameters:

referenced_tables (Optional[Sequence[str]]) – The tables referenced in the analysis schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_schema_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSchemaProperty(
    referenced_tables=["referencedTables"]
)

Attributes

referenced_tables

The tables referenced in the analysis schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables

AnalysisSourceMetadataProperty

class CfnAnalysisTemplatePropsMixin.AnalysisSourceMetadataProperty(*, artifacts=None)

Bases: object

The analysis source metadata.

Parameters:

artifacts (Union[IResolvable, AnalysisTemplateArtifactMetadataProperty, Dict[str, Any], None]) – The artifacts of the analysis source metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_source_metadata_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSourceMetadataProperty(
    artifacts=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactMetadataProperty(
        additional_artifact_hashes=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
            sha256="sha256"
        )],
        entry_point_hash=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
            sha256="sha256"
        )
    )
)

Attributes

artifacts

The artifacts of the analysis source metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissourcemetadata.html#cfn-cleanrooms-analysistemplate-analysissourcemetadata-artifacts

AnalysisSourceProperty

class CfnAnalysisTemplatePropsMixin.AnalysisSourceProperty(*, artifacts=None, text=None)

Bases: object

The structure that defines the body of the analysis template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_source_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisSourceProperty(
    artifacts=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactsProperty(
        additional_artifacts=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
            location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
                bucket="bucket",
                key="key"
            )
        )],
        entry_point=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
            location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
                bucket="bucket",
                key="key"
            )
        ),
        role_arn="roleArn"
    ),
    text="text"
)

Attributes

artifacts

The artifacts of the analysis source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-artifacts

text

The query text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-text

AnalysisTemplateArtifactMetadataProperty

class CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactMetadataProperty(*, additional_artifact_hashes=None, entry_point_hash=None)

Bases: object

The analysis template artifact metadata.

Parameters:

  • additional_artifact_hashes (Union[IResolvable, Sequence[Union[IResolvable, HashProperty, Dict[str, Any]]], None]) – Additional artifact hashes for the analysis template.

  • entry_point_hash (Union[IResolvable, HashProperty, Dict[str, Any], None]) – The hash of the entry point for the analysis template artifact metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_template_artifact_metadata_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactMetadataProperty(
    additional_artifact_hashes=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
        sha256="sha256"
    )],
    entry_point_hash=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
        sha256="sha256"
    )
)

Attributes

additional_artifact_hashes

Additional artifact hashes for the analysis template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-additionalartifacthashes

entry_point_hash

The hash of the entry point for the analysis template artifact metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifactmetadata.html#cfn-cleanrooms-analysistemplate-analysistemplateartifactmetadata-entrypointhash

AnalysisTemplateArtifactProperty

class CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(*, location=None)

Bases: object

The analysis template artifact.

Parameters:

location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The artifact location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_template_artifact_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
    location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
        bucket="bucket",
        key="key"
    )
)

Attributes

location

The artifact location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifact.html#cfn-cleanrooms-analysistemplate-analysistemplateartifact-location

AnalysisTemplateArtifactsProperty

class CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactsProperty(*, additional_artifacts=None, entry_point=None, role_arn=None)

Bases: object

The analysis template artifacts.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

analysis_template_artifacts_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactsProperty(
    additional_artifacts=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
        location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
            bucket="bucket",
            key="key"
        )
    )],
    entry_point=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.AnalysisTemplateArtifactProperty(
        location=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
            bucket="bucket",
            key="key"
        )
    ),
    role_arn="roleArn"
)

Attributes

additional_artifacts

Additional artifacts for the analysis template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-additionalartifacts

entry_point

The entry point for the analysis template artifacts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-entrypoint

role_arn

The role ARN for the analysis template artifacts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysistemplateartifacts.html#cfn-cleanrooms-analysistemplate-analysistemplateartifacts-rolearn

ColumnClassificationDetailsProperty

class CfnAnalysisTemplatePropsMixin.ColumnClassificationDetailsProperty(*, column_mapping=None)

Bases: object

Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.

Parameters:

column_mapping (Union[IResolvable, Sequence[Union[IResolvable, SyntheticDataColumnPropertiesProperty, Dict[str, Any]]], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

column_classification_details_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ColumnClassificationDetailsProperty(
    column_mapping=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(
        column_name="columnName",
        column_type="columnType",
        is_predictive_value=False
    )]
)

Attributes

column_mapping

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-columnclassificationdetails.html#cfn-cleanrooms-analysistemplate-columnclassificationdetails-columnmapping

ErrorMessageConfigurationProperty

class CfnAnalysisTemplatePropsMixin.ErrorMessageConfigurationProperty(*, type=None)

Bases: object

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.

Parameters:

type (Optional[str]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-errormessageconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

error_message_configuration_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ErrorMessageConfigurationProperty(
    type="type"
)

Attributes

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.

See:

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

HashProperty

class CfnAnalysisTemplatePropsMixin.HashProperty(*, sha256=None)

Bases: object

Hash.

Parameters:

sha256 (Optional[str]) – The SHA-256 hash value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

hash_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.HashProperty(
    sha256="sha256"
)

Attributes

sha256

The SHA-256 hash value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-hash.html#cfn-cleanrooms-analysistemplate-hash-sha256

MLSyntheticDataParametersProperty

class CfnAnalysisTemplatePropsMixin.MLSyntheticDataParametersProperty(*, column_classification=None, epsilon=None, max_membership_inference_attack_score=None)

Bases: object

Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details.

Parameters:

  • column_classification (Union[IResolvable, ColumnClassificationDetailsProperty, Dict[str, Any], None]) – Classification details for data columns that specify how each column should be treated during synthetic data generation.

  • epsilon (Union[int, float, None]) – The epsilon value for differential privacy when generating synthetic data. Lower values provide stronger privacy guarantees but may reduce data utility.

  • max_membership_inference_attack_score (Union[int, float, None]) – The maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

m_lSynthetic_data_parameters_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.MLSyntheticDataParametersProperty(
    column_classification=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ColumnClassificationDetailsProperty(
        column_mapping=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(
            column_name="columnName",
            column_type="columnType",
            is_predictive_value=False
        )]
    ),
    epsilon=123,
    max_membership_inference_attack_score=123
)

Attributes

column_classification

Classification details for data columns that specify how each column should be treated during synthetic data generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-columnclassification

epsilon

The epsilon value for differential privacy when generating synthetic data.

Lower values provide stronger privacy guarantees but may reduce data utility.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-epsilon

max_membership_inference_attack_score

The maximum acceptable score for membership inference attack vulnerability.

Synthetic data generation fails if the score for the resulting data exceeds this threshold.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-mlsyntheticdataparameters.html#cfn-cleanrooms-analysistemplate-mlsyntheticdataparameters-maxmembershipinferenceattackscore

S3LocationProperty

class CfnAnalysisTemplatePropsMixin.S3LocationProperty(*, bucket=None, key=None)

Bases: object

The S3 location.

Parameters:

  • bucket (Optional[str]) – The bucket name.

  • key (Optional[str]) – The object key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

s3_location_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

The bucket name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-bucket

key

The object key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-s3location.html#cfn-cleanrooms-analysistemplate-s3location-key

SyntheticDataColumnPropertiesProperty

class CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(*, column_name=None, column_type=None, is_predictive_value=None)

Bases: object

Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.

Parameters:

  • column_name (Optional[str]) – The name of the data column as it appears in the dataset.

  • column_type (Optional[str]) – The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.

  • is_predictive_value (Union[bool, IResolvable, None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

synthetic_data_column_properties_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(
    column_name="columnName",
    column_type="columnType",
    is_predictive_value=False
)

Attributes

column_name

The name of the data column as it appears in the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columnname

column_type

The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-columntype

is_predictive_value

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdatacolumnproperties.html#cfn-cleanrooms-analysistemplate-syntheticdatacolumnproperties-ispredictivevalue

SyntheticDataParametersProperty

class CfnAnalysisTemplatePropsMixin.SyntheticDataParametersProperty(*, ml_synthetic_data_parameters=None)

Bases: object

The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.

Parameters:

ml_synthetic_data_parameters (Union[IResolvable, MLSyntheticDataParametersProperty, Dict[str, Any], None]) – The machine learning-specific parameters for synthetic data generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

synthetic_data_parameters_property = cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataParametersProperty(
    ml_synthetic_data_parameters=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.MLSyntheticDataParametersProperty(
        column_classification=cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.ColumnClassificationDetailsProperty(
            column_mapping=[cleanrooms_mixins.CfnAnalysisTemplatePropsMixin.SyntheticDataColumnPropertiesProperty(
                column_name="columnName",
                column_type="columnType",
                is_predictive_value=False
            )]
        ),
        epsilon=123,
        max_membership_inference_attack_score=123
    )
)

Attributes

ml_synthetic_data_parameters

The machine learning-specific parameters for synthetic data generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-syntheticdataparameters.html#cfn-cleanrooms-analysistemplate-syntheticdataparameters-mlsyntheticdataparameters