CfnConfiguredTableAssociationPropsMixin

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

Bases: Mixin

Creates a configured table association.

A configured table association links a configured table with a collaboration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html
CloudformationResource:: AWS::CleanRooms::ConfiguredTableAssociation
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_configured_table_association_props_mixin = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin(cleanrooms_mixins.CfnConfiguredTableAssociationMixinProps(
    configured_table_association_analysis_rules=[cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleProperty(
        policy=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyProperty(
            v1=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyV1Property(
                aggregation=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(
                    allowed_additional_analyses=["allowedAdditionalAnalyses"],
                    allowed_result_receivers=["allowedResultReceivers"]
                ),
                custom=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(
                    allowed_additional_analyses=["allowedAdditionalAnalyses"],
                    allowed_result_receivers=["allowedResultReceivers"]
                ),
                list=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(
                    allowed_additional_analyses=["allowedAdditionalAnalyses"],
                    allowed_result_receivers=["allowedResultReceivers"]
                )
            )
        ),
        type="type"
    )],
    configured_table_identifier="configuredTableIdentifier",
    description="description",
    membership_identifier="membershipIdentifier",
    name="name",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnConfiguredTableAssociationMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configuredTableAssociationAnalysisRules', 'configuredTableIdentifier', 'description', 'membershipIdentifier', 'name', 'roleArn', '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

ConfiguredTableAssociationAnalysisRuleAggregationProperty

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)

Bases: object

The configured table association analysis rule applied to a configured table with the aggregation analysis rule.

Parameters:

allowed_additional_analyses (Optional[Sequence[str]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList ) and the custom analysis rule ( AnalysisRuleCustom ).
allowed_result_receivers (Optional[Sequence[str]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.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

configured_table_association_analysis_rule_aggregation_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(
    allowed_additional_analyses=["allowedAdditionalAnalyses"],
    allowed_result_receivers=["allowedResultReceivers"]
)

Attributes

allowed_additional_analyses

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList ) and the custom analysis rule ( AnalysisRuleCustom ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedadditionalanalyses

allowed_result_receivers

The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedresultreceivers

ConfiguredTableAssociationAnalysisRuleCustomProperty

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)

Bases: object

The configured table association analysis rule applied to a configured table with the custom analysis rule.

Parameters:

allowed_additional_analyses (Optional[Sequence[str]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
allowed_result_receivers (Optional[Sequence[str]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.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

configured_table_association_analysis_rule_custom_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(
    allowed_additional_analyses=["allowedAdditionalAnalyses"],
    allowed_result_receivers=["allowedResultReceivers"]
)

Attributes

allowed_additional_analyses

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedadditionalanalyses

allowed_result_receivers

The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedresultreceivers

ConfiguredTableAssociationAnalysisRuleListProperty

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)

Bases: object

The configured table association analysis rule applied to a configured table with the list analysis rule.

Parameters:

allowed_additional_analyses (Optional[Sequence[str]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
allowed_result_receivers (Optional[Sequence[str]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.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

configured_table_association_analysis_rule_list_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(
    allowed_additional_analyses=["allowedAdditionalAnalyses"],
    allowed_result_receivers=["allowedResultReceivers"]
)

Attributes

allowed_additional_analyses

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedadditionalanalyses

allowed_result_receivers

The list of collaboration members who are allowed to receive results of queries run with this configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedresultreceivers

ConfiguredTableAssociationAnalysisRulePolicyProperty

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyProperty(*, v1=None)

Bases: object

Controls on the query specifications that can be run on an associated configured table.

Parameters:: v1 (Union[IResolvable, ConfiguredTableAssociationAnalysisRulePolicyV1Property, Dict[str, Any], None]) – The policy for the configured table association analysis rule.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.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

configured_table_association_analysis_rule_policy_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyProperty(
    v1=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyV1Property(
        aggregation=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(
            allowed_additional_analyses=["allowedAdditionalAnalyses"],
            allowed_result_receivers=["allowedResultReceivers"]
        ),
        custom=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(
            allowed_additional_analyses=["allowedAdditionalAnalyses"],
            allowed_result_receivers=["allowedResultReceivers"]
        ),
        list=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(
            allowed_additional_analyses=["allowedAdditionalAnalyses"],
            allowed_result_receivers=["allowedResultReceivers"]
        )
    )
)

Attributes

v1

The policy for the configured table association analysis rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy-v1

ConfiguredTableAssociationAnalysisRulePolicyV1Property

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyV1Property(*, aggregation=None, custom=None, list=None)

Bases: object

Controls on the query specifications that can be run on an associated configured table.

Parameters:

aggregation (Union[IResolvable, ConfiguredTableAssociationAnalysisRuleAggregationProperty, Dict[str, Any], None]) – Analysis rule type that enables only aggregation queries on a configured table.
custom (Union[IResolvable, ConfiguredTableAssociationAnalysisRuleCustomProperty, Dict[str, Any], None]) – Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
list (Union[IResolvable, ConfiguredTableAssociationAnalysisRuleListProperty, Dict[str, Any], None]) – Analysis rule type that enables only list queries on a configured table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.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

configured_table_association_analysis_rule_policy_v1_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyV1Property(
    aggregation=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(
        allowed_additional_analyses=["allowedAdditionalAnalyses"],
        allowed_result_receivers=["allowedResultReceivers"]
    ),
    custom=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(
        allowed_additional_analyses=["allowedAdditionalAnalyses"],
        allowed_result_receivers=["allowedResultReceivers"]
    ),
    list=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(
        allowed_additional_analyses=["allowedAdditionalAnalyses"],
        allowed_result_receivers=["allowedResultReceivers"]
    )
)

Attributes

aggregation

Analysis rule type that enables only aggregation queries on a configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-aggregation

custom

Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables.

It supports differential privacy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-custom

list

Analysis rule type that enables only list queries on a configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-list

ConfiguredTableAssociationAnalysisRuleProperty

class CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleProperty(*, policy=None, type=None)

Bases: object

An analysis rule for a configured table association.

This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule .

Parameters:

policy (Union[IResolvable, ConfiguredTableAssociationAnalysisRulePolicyProperty, Dict[str, Any], None]) – The policy of the configured table association analysis rule.
type (Optional[str]) – The type of the configured table association analysis rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.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

configured_table_association_analysis_rule_property = cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleProperty(
    policy=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyProperty(
        v1=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRulePolicyV1Property(
            aggregation=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleAggregationProperty(
                allowed_additional_analyses=["allowedAdditionalAnalyses"],
                allowed_result_receivers=["allowedResultReceivers"]
            ),
            custom=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleCustomProperty(
                allowed_additional_analyses=["allowedAdditionalAnalyses"],
                allowed_result_receivers=["allowedResultReceivers"]
            ),
            list=cleanrooms_mixins.CfnConfiguredTableAssociationPropsMixin.ConfiguredTableAssociationAnalysisRuleListProperty(
                allowed_additional_analyses=["allowedAdditionalAnalyses"],
                allowed_result_receivers=["allowedResultReceivers"]
            )
        )
    ),
    type="type"
)

Attributes

policy

The policy of the configured table association analysis rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-policy

type

The type of the configured table association analysis rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-type