Package software.amazon.awscdk.services.cleanrooms

Interface CfnAnalysisTemplate.MLSyntheticDataParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Jsii$Proxy

Enclosing class:

CfnAnalysisTemplate

@Stability(Stable)
public static interface CfnAnalysisTemplate.MLSyntheticDataParametersProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 MLSyntheticDataParametersProperty mLSyntheticDataParametersProperty = MLSyntheticDataParametersProperty.builder()
         .columnClassification(ColumnClassificationDetailsProperty.builder()
                 .columnMapping(List.of(SyntheticDataColumnPropertiesProperty.builder()
                         .columnName("columnName")
                         .columnType("columnType")
                         .isPredictiveValue(false)
                         .build()))
                 .build())
         .epsilon(123)
         .maxMembershipInferenceAttackScore(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Builder	A builder for CfnAnalysisTemplate.MLSyntheticDataParametersProperty
static final class	CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Jsii$Proxy	An implementation for CfnAnalysisTemplate.MLSyntheticDataParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Builder	builder()
Object	getColumnClassification()	Classification details for data columns that specify how each column should be treated during synthetic data generation.
Number	getEpsilon()	The epsilon value for differential privacy when generating synthetic data.
Number	getMaxMembershipInferenceAttackScore()	The maximum acceptable score for membership inference attack vulnerability.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnClassification

@Stability(Stable)
@NotNull
Object getColumnClassification()

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

Returns union: either IResolvable or CfnAnalysisTemplate.ColumnClassificationDetailsProperty

See Also:

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

getEpsilon

@Stability(Stable)
@NotNull
Number getEpsilon()

The epsilon value for differential privacy when generating synthetic data.

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

See Also:

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

getMaxMembershipInferenceAttackScore

@Stability(Stable)
@NotNull
Number getMaxMembershipInferenceAttackScore()

The maximum acceptable score for membership inference attack vulnerability.

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

See Also:

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

builder

@Stability(Stable)
static CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Builder builder()

Returns:

a CfnAnalysisTemplate.MLSyntheticDataParametersProperty.Builder of CfnAnalysisTemplate.MLSyntheticDataParametersProperty