CfnCollaborationProps Struct
Properties for defining a CfnCollaboration.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const cfnCollaborationProps: cleanrooms.CfnCollaborationProps = {
creatorDisplayName: 'creatorDisplayName',
description: 'description',
name: 'name',
queryLogStatus: 'queryLogStatus',
// the properties below are optional
allowedResultRegions: ['allowedResultRegions'],
analyticsEngine: 'analyticsEngine',
autoApprovedChangeTypes: ['autoApprovedChangeTypes'],
creatorMemberAbilities: ['creatorMemberAbilities'],
creatorMlMemberAbilities: {
customMlMemberAbilities: ['customMlMemberAbilities'],
},
creatorPaymentConfiguration: {
queryCompute: {
isResponsible: false,
},
// the properties below are optional
jobCompute: {
isResponsible: false,
},
machineLearning: {
modelInference: {
isResponsible: false,
},
modelTraining: {
isResponsible: false,
},
syntheticDataGeneration: {
isResponsible: false,
},
},
},
dataEncryptionMetadata: {
allowCleartext: false,
allowDuplicates: false,
allowJoinsOnColumnsWithDifferentNames: false,
preserveNulls: false,
},
isMetricsEnabled: false,
jobLogStatus: 'jobLogStatus',
members: [{
accountId: 'accountId',
displayName: 'displayName',
// the properties below are optional
memberAbilities: ['memberAbilities'],
mlMemberAbilities: {
customMlMemberAbilities: ['customMlMemberAbilities'],
},
paymentConfiguration: {
queryCompute: {
isResponsible: false,
},
// the properties below are optional
jobCompute: {
isResponsible: false,
},
machineLearning: {
modelInference: {
isResponsible: false,
},
modelTraining: {
isResponsible: false,
},
syntheticDataGeneration: {
isResponsible: false,
},
},
},
}],
tags: [{
key: 'key',
value: 'value',
}],
};
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 import aws_cleanrooms as cleanrooms
cfn_collaboration_props = cleanrooms.CfnCollaborationProps(
creator_display_name="creatorDisplayName",
description="description",
name="name",
query_log_status="queryLogStatus",
# the properties below are optional
allowed_result_regions=["allowedResultRegions"],
analytics_engine="analyticsEngine",
auto_approved_change_types=["autoApprovedChangeTypes"],
creator_member_abilities=["creatorMemberAbilities"],
creator_ml_member_abilities=cleanrooms.CfnCollaboration.MLMemberAbilitiesProperty(
custom_ml_member_abilities=["customMlMemberAbilities"]
),
creator_payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
is_responsible=False
),
# the properties below are optional
job_compute=cleanrooms.CfnCollaboration.JobComputePaymentConfigProperty(
is_responsible=False
),
machine_learning=cleanrooms.CfnCollaboration.MLPaymentConfigProperty(
model_inference=cleanrooms.CfnCollaboration.ModelInferencePaymentConfigProperty(
is_responsible=False
),
model_training=cleanrooms.CfnCollaboration.ModelTrainingPaymentConfigProperty(
is_responsible=False
),
synthetic_data_generation=cleanrooms.CfnCollaboration.SyntheticDataGenerationPaymentConfigProperty(
is_responsible=False
)
)
),
data_encryption_metadata=cleanrooms.CfnCollaboration.DataEncryptionMetadataProperty(
allow_cleartext=False,
allow_duplicates=False,
allow_joins_on_columns_with_different_names=False,
preserve_nulls=False
),
is_metrics_enabled=False,
job_log_status="jobLogStatus",
members=[cleanrooms.CfnCollaboration.MemberSpecificationProperty(
account_id="accountId",
display_name="displayName",
# the properties below are optional
member_abilities=["memberAbilities"],
ml_member_abilities=cleanrooms.CfnCollaboration.MLMemberAbilitiesProperty(
custom_ml_member_abilities=["customMlMemberAbilities"]
),
payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
is_responsible=False
),
# the properties below are optional
job_compute=cleanrooms.CfnCollaboration.JobComputePaymentConfigProperty(
is_responsible=False
),
machine_learning=cleanrooms.CfnCollaboration.MLPaymentConfigProperty(
model_inference=cleanrooms.CfnCollaboration.ModelInferencePaymentConfigProperty(
is_responsible=False
),
model_training=cleanrooms.CfnCollaboration.ModelTrainingPaymentConfigProperty(
is_responsible=False
),
synthetic_data_generation=cleanrooms.CfnCollaboration.SyntheticDataGenerationPaymentConfigProperty(
is_responsible=False
)
)
)
)],
tags=[CfnTag(
key="key",
value="value"
)]
)
// 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.*;
CfnCollaborationProps cfnCollaborationProps = CfnCollaborationProps.builder()
.creatorDisplayName("creatorDisplayName")
.description("description")
.name("name")
.queryLogStatus("queryLogStatus")
// the properties below are optional
.allowedResultRegions(List.of("allowedResultRegions"))
.analyticsEngine("analyticsEngine")
.autoApprovedChangeTypes(List.of("autoApprovedChangeTypes"))
.creatorMemberAbilities(List.of("creatorMemberAbilities"))
.creatorMlMemberAbilities(MLMemberAbilitiesProperty.builder()
.customMlMemberAbilities(List.of("customMlMemberAbilities"))
.build())
.creatorPaymentConfiguration(PaymentConfigurationProperty.builder()
.queryCompute(QueryComputePaymentConfigProperty.builder()
.isResponsible(false)
.build())
// the properties below are optional
.jobCompute(JobComputePaymentConfigProperty.builder()
.isResponsible(false)
.build())
.machineLearning(MLPaymentConfigProperty.builder()
.modelInference(ModelInferencePaymentConfigProperty.builder()
.isResponsible(false)
.build())
.modelTraining(ModelTrainingPaymentConfigProperty.builder()
.isResponsible(false)
.build())
.syntheticDataGeneration(SyntheticDataGenerationPaymentConfigProperty.builder()
.isResponsible(false)
.build())
.build())
.build())
.dataEncryptionMetadata(DataEncryptionMetadataProperty.builder()
.allowCleartext(false)
.allowDuplicates(false)
.allowJoinsOnColumnsWithDifferentNames(false)
.preserveNulls(false)
.build())
.isMetricsEnabled(false)
.jobLogStatus("jobLogStatus")
.members(List.of(MemberSpecificationProperty.builder()
.accountId("accountId")
.displayName("displayName")
// the properties below are optional
.memberAbilities(List.of("memberAbilities"))
.mlMemberAbilities(MLMemberAbilitiesProperty.builder()
.customMlMemberAbilities(List.of("customMlMemberAbilities"))
.build())
.paymentConfiguration(PaymentConfigurationProperty.builder()
.queryCompute(QueryComputePaymentConfigProperty.builder()
.isResponsible(false)
.build())
// the properties below are optional
.jobCompute(JobComputePaymentConfigProperty.builder()
.isResponsible(false)
.build())
.machineLearning(MLPaymentConfigProperty.builder()
.modelInference(ModelInferencePaymentConfigProperty.builder()
.isResponsible(false)
.build())
.modelTraining(ModelTrainingPaymentConfigProperty.builder()
.isResponsible(false)
.build())
.syntheticDataGeneration(SyntheticDataGenerationPaymentConfigProperty.builder()
.isResponsible(false)
.build())
.build())
.build())
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CleanRooms;
var cfnCollaborationProps = new CfnCollaborationProps {
CreatorDisplayName = "creatorDisplayName",
Description = "description",
Name = "name",
QueryLogStatus = "queryLogStatus",
// the properties below are optional
AllowedResultRegions = new [] { "allowedResultRegions" },
AnalyticsEngine = "analyticsEngine",
AutoApprovedChangeTypes = new [] { "autoApprovedChangeTypes" },
CreatorMemberAbilities = new [] { "creatorMemberAbilities" },
CreatorMlMemberAbilities = new MLMemberAbilitiesProperty {
CustomMlMemberAbilities = new [] { "customMlMemberAbilities" }
},
CreatorPaymentConfiguration = new PaymentConfigurationProperty {
QueryCompute = new QueryComputePaymentConfigProperty {
IsResponsible = false
},
// the properties below are optional
JobCompute = new JobComputePaymentConfigProperty {
IsResponsible = false
},
MachineLearning = new MLPaymentConfigProperty {
ModelInference = new ModelInferencePaymentConfigProperty {
IsResponsible = false
},
ModelTraining = new ModelTrainingPaymentConfigProperty {
IsResponsible = false
},
SyntheticDataGeneration = new SyntheticDataGenerationPaymentConfigProperty {
IsResponsible = false
}
}
},
DataEncryptionMetadata = new DataEncryptionMetadataProperty {
AllowCleartext = false,
AllowDuplicates = false,
AllowJoinsOnColumnsWithDifferentNames = false,
PreserveNulls = false
},
IsMetricsEnabled = false,
JobLogStatus = "jobLogStatus",
Members = new [] { new MemberSpecificationProperty {
AccountId = "accountId",
DisplayName = "displayName",
// the properties below are optional
MemberAbilities = new [] { "memberAbilities" },
MlMemberAbilities = new MLMemberAbilitiesProperty {
CustomMlMemberAbilities = new [] { "customMlMemberAbilities" }
},
PaymentConfiguration = new PaymentConfigurationProperty {
QueryCompute = new QueryComputePaymentConfigProperty {
IsResponsible = false
},
// the properties below are optional
JobCompute = new JobComputePaymentConfigProperty {
IsResponsible = false
},
MachineLearning = new MLPaymentConfigProperty {
ModelInference = new ModelInferencePaymentConfigProperty {
IsResponsible = false
},
ModelTraining = new ModelTrainingPaymentConfigProperty {
IsResponsible = false
},
SyntheticDataGeneration = new SyntheticDataGenerationPaymentConfigProperty {
IsResponsible = false
}
}
}
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCollaborationProps := &CfnCollaborationProps{
CreatorDisplayName: jsii.String("creatorDisplayName"),
Description: jsii.String("description"),
Name: jsii.String("name"),
QueryLogStatus: jsii.String("queryLogStatus"),
// the properties below are optional
AllowedResultRegions: []*string{
jsii.String("allowedResultRegions"),
},
AnalyticsEngine: jsii.String("analyticsEngine"),
AutoApprovedChangeTypes: []*string{
jsii.String("autoApprovedChangeTypes"),
},
CreatorMemberAbilities: []*string{
jsii.String("creatorMemberAbilities"),
},
CreatorMlMemberAbilities: &MLMemberAbilitiesProperty{
CustomMlMemberAbilities: []*string{
jsii.String("customMlMemberAbilities"),
},
},
CreatorPaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
// the properties below are optional
JobCompute: &JobComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
MachineLearning: &MLPaymentConfigProperty{
ModelInference: &ModelInferencePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
ModelTraining: &ModelTrainingPaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
SyntheticDataGeneration: &SyntheticDataGenerationPaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
},
DataEncryptionMetadata: &DataEncryptionMetadataProperty{
AllowCleartext: jsii.Boolean(false),
AllowDuplicates: jsii.Boolean(false),
AllowJoinsOnColumnsWithDifferentNames: jsii.Boolean(false),
PreserveNulls: jsii.Boolean(false),
},
IsMetricsEnabled: jsii.Boolean(false),
JobLogStatus: jsii.String("jobLogStatus"),
Members: []interface{}{
&MemberSpecificationProperty{
AccountId: jsii.String("accountId"),
DisplayName: jsii.String("displayName"),
// the properties below are optional
MemberAbilities: []*string{
jsii.String("memberAbilities"),
},
MlMemberAbilities: &MLMemberAbilitiesProperty{
CustomMlMemberAbilities: []*string{
jsii.String("customMlMemberAbilities"),
},
},
PaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
// the properties below are optional
JobCompute: &JobComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
MachineLearning: &MLPaymentConfigProperty{
ModelInference: &ModelInferencePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
ModelTraining: &ModelTrainingPaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
SyntheticDataGeneration: &SyntheticDataGenerationPaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
allowedResultRegionsoptionalstring[]allowed_result_regionsoptionaltyping.List[str]allowedResultRegionsoptionalList<String>AllowedResultRegionsoptionalstring[]AllowedResultRegionsoptional*[]*string#Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
analyticsEngineoptionalstringanalytics_engineoptionalstranalyticsEngineoptionalStringAnalyticsEngineoptionalstringAnalyticsEngineoptional*string#After July 16, 2025, the
CLEAN_ROOMS_SQLparameter will no longer be available.
autoApprovedChangeTypesoptionalstring[]auto_approved_change_typesoptionaltyping.List[str]autoApprovedChangeTypesoptionalList<String>AutoApprovedChangeTypesoptionalstring[]AutoApprovedChangeTypesoptional*[]*string#creatorDisplayNamestringcreator_display_namestrcreatorDisplayNameStringCreatorDisplayNamestringCreatorDisplayName*stringrequired#creatorMemberAbilitiesoptionalstring[]creator_member_abilitiesoptionaltyping.List[str]creatorMemberAbilitiesoptionalList<String>CreatorMemberAbilitiesoptionalstring[]CreatorMemberAbilitiesoptional*[]*string#Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB
creatorMlMemberAbilitiesoptionalIResolvable | CfnCollaboration.MLMemberAbilitiesPropertycreator_ml_member_abilitiesoptionaltyping.Union[IResolvable, MLMemberAbilitiesProperty]creatorMlMemberAbilitiesoptionalIResolvableCreatorMlMemberAbilitiesoptionalIResolvableCreatorMlMemberAbilitiesoptionalinterface{}#creatorPaymentConfigurationoptionalIResolvable | CfnCollaboration.PaymentConfigurationPropertycreator_payment_configurationoptionaltyping.Union[IResolvable, PaymentConfigurationProperty]creatorPaymentConfigurationoptionalIResolvableCreatorPaymentConfigurationoptionalIResolvableCreatorPaymentConfigurationoptionalinterface{}#dataEncryptionMetadataoptionalIResolvable | CfnCollaboration.DataEncryptionMetadataPropertydata_encryption_metadataoptionaltyping.Union[IResolvable, DataEncryptionMetadataProperty]dataEncryptionMetadataoptionalIResolvableDataEncryptionMetadataoptionalIResolvableDataEncryptionMetadataoptionalinterface{}#isMetricsEnabledoptionalboolean | IResolvableis_metrics_enabledoptionaltyping.Union[bool, IResolvable]isMetricsEnabledoptionalBooleanIsMetricsEnabledoptionalboolIsMetricsEnabledoptionalinterface{}#jobLogStatusoptionalstringjob_log_statusoptionalstrjobLogStatusoptionalStringJobLogStatusoptionalstringJobLogStatusoptional*string#When ENABLED , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED .
membersoptionalIResolvable | IResolvable | CfnCollaboration.MemberSpecificationProperty[]membersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MemberSpecificationProperty]]]membersoptionalIResolvableMembersoptionalIResolvableMembersoptionalinterface{}#This list is immutable.
Display names are not unique.
queryLogStatusstringquery_log_statusstrqueryLogStatusStringQueryLogStatusstringQueryLogStatus*stringrequired#When ENABLED , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#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.