CfnConfiguredTableMixinProps

class aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnConfiguredTableMixinProps(*, allowed_columns=None, analysis_method=None, analysis_rules=None, description=None, name=None, selected_analysis_methods=None, table_reference=None, tags=None)

Bases: object

Properties for CfnConfiguredTablePropsMixin.

Parameters:

allowed_columns (Optional[Sequence[str]]) – The columns within the underlying AWS Glue table that can be used within collaborations.
analysis_method (Optional[str]) – The analysis method for the configured table. DIRECT_QUERY allows SQL queries to be run directly on this table. DIRECT_JOB allows PySpark jobs to be run directly on this table. MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
analysis_rules (Union[IResolvable, Sequence[Union[IResolvable, AnalysisRuleProperty, Dict[str, Any]]], None]) – The analysis rule that was created for the configured table.
description (Optional[str]) – A description for the configured table.
name (Optional[str]) – A name for the configured table.
selected_analysis_methods (Optional[Sequence[str]]) – The selected analysis methods for the configured table.
table_reference (Union[IResolvable, TableReferenceProperty, Dict[str, Any], None]) – The table that this configured table represents.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An optional label that you can assign to a resource when you create it. 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.

See:

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

cfn_configured_table_mixin_props = cleanrooms_mixins.CfnConfiguredTableMixinProps(
    allowed_columns=["allowedColumns"],
    analysis_method="analysisMethod",
    analysis_rules=[cleanrooms_mixins.CfnConfiguredTablePropsMixin.AnalysisRuleProperty(
        policy=cleanrooms_mixins.CfnConfiguredTablePropsMixin.ConfiguredTableAnalysisRulePolicyProperty(
            v1=cleanrooms_mixins.CfnConfiguredTablePropsMixin.ConfiguredTableAnalysisRulePolicyV1Property(
                aggregation=cleanrooms_mixins.CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty(
                    additional_analyses="additionalAnalyses",
                    aggregate_columns=[cleanrooms_mixins.CfnConfiguredTablePropsMixin.AggregateColumnProperty(
                        column_names=["columnNames"],
                        function="function"
                    )],
                    allowed_join_operators=["allowedJoinOperators"],
                    dimension_columns=["dimensionColumns"],
                    join_columns=["joinColumns"],
                    join_required="joinRequired",
                    output_constraints=[cleanrooms_mixins.CfnConfiguredTablePropsMixin.AggregationConstraintProperty(
                        column_name="columnName",
                        minimum=123,
                        type="type"
                    )],
                    scalar_functions=["scalarFunctions"]
                ),
                custom=cleanrooms_mixins.CfnConfiguredTablePropsMixin.AnalysisRuleCustomProperty(
                    additional_analyses="additionalAnalyses",
                    allowed_analyses=["allowedAnalyses"],
                    allowed_analysis_providers=["allowedAnalysisProviders"],
                    differential_privacy=cleanrooms_mixins.CfnConfiguredTablePropsMixin.DifferentialPrivacyProperty(
                        columns=[cleanrooms_mixins.CfnConfiguredTablePropsMixin.DifferentialPrivacyColumnProperty(
                            name="name"
                        )]
                    ),
                    disallowed_output_columns=["disallowedOutputColumns"]
                ),
                list=cleanrooms_mixins.CfnConfiguredTablePropsMixin.AnalysisRuleListProperty(
                    additional_analyses="additionalAnalyses",
                    allowed_join_operators=["allowedJoinOperators"],
                    join_columns=["joinColumns"],
                    list_columns=["listColumns"]
                )
            )
        ),
        type="type"
    )],
    description="description",
    name="name",
    selected_analysis_methods=["selectedAnalysisMethods"],
    table_reference=cleanrooms_mixins.CfnConfiguredTablePropsMixin.TableReferenceProperty(
        athena=cleanrooms_mixins.CfnConfiguredTablePropsMixin.AthenaTableReferenceProperty(
            database_name="databaseName",
            output_location="outputLocation",
            region="region",
            table_name="tableName",
            work_group="workGroup"
        ),
        glue=cleanrooms_mixins.CfnConfiguredTablePropsMixin.GlueTableReferenceProperty(
            database_name="databaseName",
            region="region",
            table_name="tableName"
        ),
        snowflake=cleanrooms_mixins.CfnConfiguredTablePropsMixin.SnowflakeTableReferenceProperty(
            account_identifier="accountIdentifier",
            database_name="databaseName",
            schema_name="schemaName",
            secret_arn="secretArn",
            table_name="tableName",
            table_schema=cleanrooms_mixins.CfnConfiguredTablePropsMixin.SnowflakeTableSchemaProperty(
                v1=[cleanrooms_mixins.CfnConfiguredTablePropsMixin.SnowflakeTableSchemaV1Property(
                    column_name="columnName",
                    column_type="columnType"
                )]
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allowed_columns

The columns within the underlying AWS Glue table that can be used within collaborations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-allowedcolumns

analysis_method

The analysis method for the configured table.

DIRECT_QUERY allows SQL queries to be run directly on this table.

DIRECT_JOB allows PySpark jobs to be run directly on this table.

MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysismethod

analysis_rules

The analysis rule that was created for the configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysisrules

description

A description for the configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-description

name

A name for the configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-name

selected_analysis_methods

The selected analysis methods for the configured table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-selectedanalysismethods

table_reference

The table that this configured table represents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tablereference

tags

An optional label that you can assign to a resource when you create it.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tags