CfnCollaborationPropsMixin
- class aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnCollaborationPropsMixin(props, *, strategy=None)
Bases:
MixinCreates a new collaboration.
- See:
- CloudformationResource:
AWS::CleanRooms::Collaboration
- Mixin:
true
- 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 import mixins from aws_cdk.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins cfn_collaboration_props_mixin = cleanrooms_mixins.CfnCollaborationPropsMixin(cleanrooms_mixins.CfnCollaborationMixinProps( allowed_result_regions=["allowedResultRegions"], analytics_engine="analyticsEngine", auto_approved_change_types=["autoApprovedChangeTypes"], creator_display_name="creatorDisplayName", creator_member_abilities=["creatorMemberAbilities"], creator_ml_member_abilities=cleanrooms_mixins.CfnCollaborationPropsMixin.MLMemberAbilitiesProperty( custom_ml_member_abilities=["customMlMemberAbilities"] ), creator_payment_configuration=cleanrooms_mixins.CfnCollaborationPropsMixin.PaymentConfigurationProperty( job_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.JobComputePaymentConfigProperty( is_responsible=False ), machine_learning=cleanrooms_mixins.CfnCollaborationPropsMixin.MLPaymentConfigProperty( model_inference=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False ), model_training=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False ) ), query_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty( is_responsible=False ) ), data_encryption_metadata=cleanrooms_mixins.CfnCollaborationPropsMixin.DataEncryptionMetadataProperty( allow_cleartext=False, allow_duplicates=False, allow_joins_on_columns_with_different_names=False, preserve_nulls=False ), description="description", job_log_status="jobLogStatus", members=[cleanrooms_mixins.CfnCollaborationPropsMixin.MemberSpecificationProperty( account_id="accountId", display_name="displayName", member_abilities=["memberAbilities"], ml_member_abilities=cleanrooms_mixins.CfnCollaborationPropsMixin.MLMemberAbilitiesProperty( custom_ml_member_abilities=["customMlMemberAbilities"] ), payment_configuration=cleanrooms_mixins.CfnCollaborationPropsMixin.PaymentConfigurationProperty( job_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.JobComputePaymentConfigProperty( is_responsible=False ), machine_learning=cleanrooms_mixins.CfnCollaborationPropsMixin.MLPaymentConfigProperty( model_inference=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False ), model_training=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False ) ), query_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty( is_responsible=False ) ) )], name="name", query_log_status="queryLogStatus", tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::CleanRooms::Collaboration.- Parameters:
props (
Union[CfnCollaborationMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['allowedResultRegions', 'analyticsEngine', 'autoApprovedChangeTypes', 'creatorDisplayName', 'creatorMemberAbilities', 'creatorMlMemberAbilities', 'creatorPaymentConfiguration', 'dataEncryptionMetadata', 'description', 'jobLogStatus', 'members', 'name', 'queryLogStatus', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
DataEncryptionMetadataProperty
- class CfnCollaborationPropsMixin.DataEncryptionMetadataProperty(*, allow_cleartext=None, allow_duplicates=None, allow_joins_on_columns_with_different_names=None, preserve_nulls=None)
Bases:
objectThe settings for client-side encryption for cryptographic computing.
- Parameters:
allow_cleartext (
Union[bool,IResolvable,None]) – Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process every column (FALSE).allow_duplicates (
Union[bool,IResolvable,None]) – Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated values (FALSE).allow_joins_on_columns_with_different_names (
Union[bool,IResolvable,None]) – Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).preserve_nulls (
Union[bool,IResolvable,None]) – Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically processed (FALSE).
- See:
- 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 data_encryption_metadata_property = cleanrooms_mixins.CfnCollaborationPropsMixin.DataEncryptionMetadataProperty( allow_cleartext=False, allow_duplicates=False, allow_joins_on_columns_with_different_names=False, preserve_nulls=False )
Attributes
- allow_cleartext
Indicates whether encrypted tables can contain cleartext data (
TRUE) or are to cryptographically process every column (FALSE).
- allow_duplicates
Indicates whether Fingerprint columns can contain duplicate entries (
TRUE) or are to contain only non-repeated values (FALSE).
- allow_joins_on_columns_with_different_names
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (
TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
- preserve_nulls
Indicates whether NULL values are to be copied as NULL to encrypted tables (
TRUE) or cryptographically processed (FALSE).
JobComputePaymentConfigProperty
- class CfnCollaborationPropsMixin.JobComputePaymentConfigProperty(*, is_responsible=None)
Bases:
objectAn object representing the collaboration member’s payment responsibilities set by the collaboration creator for query and job compute costs.
- Parameters:
is_responsible (
Union[bool,IResolvable,None]) – Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE). Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets aTRUEvalue for more than one member in the collaboration. An error is returned if the collaboration creator sets aFALSEvalue for the member who can run queries and jobs.- See:
- 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 job_compute_payment_config_property = cleanrooms_mixins.CfnCollaborationPropsMixin.JobComputePaymentConfigProperty( is_responsible=False )
Attributes
- is_responsible
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (
TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE).Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a
TRUEvalue for more than one member in the collaboration.An error is returned if the collaboration creator sets a
FALSEvalue for the member who can run queries and jobs.
MLMemberAbilitiesProperty
- class CfnCollaborationPropsMixin.MLMemberAbilitiesProperty(*, custom_ml_member_abilities=None)
Bases:
objectThe ML member abilities for a collaboration member.
- Parameters:
custom_ml_member_abilities (
Optional[Sequence[str]]) – The custom ML member abilities for a collaboration member.- See:
- 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_lMember_abilities_property = cleanrooms_mixins.CfnCollaborationPropsMixin.MLMemberAbilitiesProperty( custom_ml_member_abilities=["customMlMemberAbilities"] )
Attributes
- custom_ml_member_abilities
The custom ML member abilities for a collaboration member.
MLPaymentConfigProperty
- class CfnCollaborationPropsMixin.MLPaymentConfigProperty(*, model_inference=None, model_training=None)
Bases:
objectAn object representing the collaboration member’s machine learning payment responsibilities set by the collaboration creator.
- Parameters:
model_inference (
Union[IResolvable,ModelInferencePaymentConfigProperty,Dict[str,Any],None]) – The payment responsibilities accepted by the member for model inference.model_training (
Union[IResolvable,ModelTrainingPaymentConfigProperty,Dict[str,Any],None]) – The payment responsibilities accepted by the member for model training.
- See:
- 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_lPayment_config_property = cleanrooms_mixins.CfnCollaborationPropsMixin.MLPaymentConfigProperty( model_inference=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False ), model_training=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False ) )
Attributes
- model_inference
The payment responsibilities accepted by the member for model inference.
- model_training
The payment responsibilities accepted by the member for model training.
MemberSpecificationProperty
- class CfnCollaborationPropsMixin.MemberSpecificationProperty(*, account_id=None, display_name=None, member_abilities=None, ml_member_abilities=None, payment_configuration=None)
Bases:
objectBasic metadata used to construct a new member.
- Parameters:
account_id (
Optional[str]) – The identifier used to reference members of the collaboration. Currently only supports AWS account ID.display_name (
Optional[str]) – The member’s display name.member_abilities (
Optional[Sequence[str]]) – The abilities granted to the collaboration member. Allowed Values :CAN_QUERY|CAN_RECEIVE_RESULTSml_member_abilities (
Union[IResolvable,MLMemberAbilitiesProperty,Dict[str,Any],None]) – The ML abilities granted to the collaboration member.payment_configuration (
Union[IResolvable,PaymentConfigurationProperty,Dict[str,Any],None]) – The collaboration member’s payment responsibilities set by the collaboration creator. If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- See:
- 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 member_specification_property = cleanrooms_mixins.CfnCollaborationPropsMixin.MemberSpecificationProperty( account_id="accountId", display_name="displayName", member_abilities=["memberAbilities"], ml_member_abilities=cleanrooms_mixins.CfnCollaborationPropsMixin.MLMemberAbilitiesProperty( custom_ml_member_abilities=["customMlMemberAbilities"] ), payment_configuration=cleanrooms_mixins.CfnCollaborationPropsMixin.PaymentConfigurationProperty( job_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.JobComputePaymentConfigProperty( is_responsible=False ), machine_learning=cleanrooms_mixins.CfnCollaborationPropsMixin.MLPaymentConfigProperty( model_inference=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False ), model_training=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False ) ), query_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty( is_responsible=False ) ) )
Attributes
- account_id
The identifier used to reference members of the collaboration.
Currently only supports AWS account ID.
- display_name
The member’s display name.
- member_abilities
The abilities granted to the collaboration member.
Allowed Values :
CAN_QUERY|CAN_RECEIVE_RESULTS
- ml_member_abilities
The ML abilities granted to the collaboration member.
- payment_configuration
The collaboration member’s payment responsibilities set by the collaboration creator.
If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
ModelInferencePaymentConfigProperty
- class CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty(*, is_responsible=None)
Bases:
objectAn object representing the collaboration member’s model inference payment responsibilities set by the collaboration creator.
- Parameters:
is_responsible (
Union[bool,IResolvable,None]) – Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE). Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets aTRUEvalue for more than one member in the collaboration. If the collaboration creator hasn’t specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets aFALSEvalue for the member who can query.- See:
- 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 model_inference_payment_config_property = cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False )
Attributes
- is_responsible
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (
TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE).Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a
TRUEvalue for more than one member in the collaboration.If the collaboration creator hasn’t specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSEvalue for the member who can query.
ModelTrainingPaymentConfigProperty
- class CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty(*, is_responsible=None)
Bases:
objectAn object representing the collaboration member’s model training payment responsibilities set by the collaboration creator.
- Parameters:
is_responsible (
Union[bool,IResolvable,None]) – Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE). Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets aTRUEvalue for more than one member in the collaboration. If the collaboration creator hasn’t specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets aFALSEvalue for the member who can query.- See:
- 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 model_training_payment_config_property = cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False )
Attributes
- is_responsible
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (
TRUE) or has not configured the collaboration member to pay for model training costs (FALSE).Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a
TRUEvalue for more than one member in the collaboration.If the collaboration creator hasn’t specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSEvalue for the member who can query.
PaymentConfigurationProperty
- class CfnCollaborationPropsMixin.PaymentConfigurationProperty(*, job_compute=None, machine_learning=None, query_compute=None)
Bases:
objectAn object representing the collaboration member’s payment responsibilities set by the collaboration creator.
- Parameters:
job_compute (
Union[IResolvable,JobComputePaymentConfigProperty,Dict[str,Any],None]) – The compute configuration for the job.machine_learning (
Union[IResolvable,MLPaymentConfigProperty,Dict[str,Any],None]) – An object representing the collaboration member’s machine learning payment responsibilities set by the collaboration creator.query_compute (
Union[IResolvable,QueryComputePaymentConfigProperty,Dict[str,Any],None]) – The collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.
- See:
- 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 payment_configuration_property = cleanrooms_mixins.CfnCollaborationPropsMixin.PaymentConfigurationProperty( job_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.JobComputePaymentConfigProperty( is_responsible=False ), machine_learning=cleanrooms_mixins.CfnCollaborationPropsMixin.MLPaymentConfigProperty( model_inference=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelInferencePaymentConfigProperty( is_responsible=False ), model_training=cleanrooms_mixins.CfnCollaborationPropsMixin.ModelTrainingPaymentConfigProperty( is_responsible=False ) ), query_compute=cleanrooms_mixins.CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty( is_responsible=False ) )
Attributes
- job_compute
The compute configuration for the job.
- machine_learning
An object representing the collaboration member’s machine learning payment responsibilities set by the collaboration creator.
- query_compute
The collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.
QueryComputePaymentConfigProperty
- class CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty(*, is_responsible=None)
Bases:
objectAn object representing the collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.
- Parameters:
is_responsible (
Union[bool,IResolvable,None]) – Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE). Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets aTRUEvalue for more than one member in the collaboration. If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets aFALSEvalue for the member who can query.- See:
- 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 query_compute_payment_config_property = cleanrooms_mixins.CfnCollaborationPropsMixin.QueryComputePaymentConfigProperty( is_responsible=False )
Attributes
- is_responsible
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (
TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE).Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a
TRUEvalue for more than one member in the collaboration.If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSEvalue for the member who can query.