Interface ICfnConfiguredTableProps

Properties for defining a CfnConfiguredTable.

Namespace: Amazon.CDK.AwsCleanrooms

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnConfiguredTableProps

Syntax (vb)

Public Interface ICfnConfiguredTableProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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 cfnConfiguredTableProps = new CfnConfiguredTableProps {
                 AllowedColumns = new [] { "allowedColumns" },
                 AnalysisMethod = "analysisMethod",
                 Name = "name",
                 TableReference = new TableReferenceProperty {
                     Athena = new AthenaTableReferenceProperty {
                         DatabaseName = "databaseName",
                         TableName = "tableName",
                         WorkGroup = "workGroup",

                         // the properties below are optional
                         OutputLocation = "outputLocation"
                     },
                     Glue = new GlueTableReferenceProperty {
                         DatabaseName = "databaseName",
                         TableName = "tableName"
                     },
                     Snowflake = new SnowflakeTableReferenceProperty {
                         AccountIdentifier = "accountIdentifier",
                         DatabaseName = "databaseName",
                         SchemaName = "schemaName",
                         SecretArn = "secretArn",
                         TableName = "tableName",
                         TableSchema = new SnowflakeTableSchemaProperty {
                             V1 = new [] { new SnowflakeTableSchemaV1Property {
                                 ColumnName = "columnName",
                                 ColumnType = "columnType"
                             } }
                         }
                     }
                 },

                 // the properties below are optional
                 AnalysisRules = new [] { new AnalysisRuleProperty {
                     Policy = new ConfiguredTableAnalysisRulePolicyProperty {
                         V1 = new ConfiguredTableAnalysisRulePolicyV1Property {
                             Aggregation = new AnalysisRuleAggregationProperty {
                                 AggregateColumns = new [] { new AggregateColumnProperty {
                                     ColumnNames = new [] { "columnNames" },
                                     Function = "function"
                                 } },
                                 DimensionColumns = new [] { "dimensionColumns" },
                                 JoinColumns = new [] { "joinColumns" },
                                 OutputConstraints = new [] { new AggregationConstraintProperty {
                                     ColumnName = "columnName",
                                     Minimum = 123,
                                     Type = "type"
                                 } },
                                 ScalarFunctions = new [] { "scalarFunctions" },

                                 // the properties below are optional
                                 AdditionalAnalyses = "additionalAnalyses",
                                 AllowedJoinOperators = new [] { "allowedJoinOperators" },
                                 JoinRequired = "joinRequired"
                             },
                             Custom = new AnalysisRuleCustomProperty {
                                 AllowedAnalyses = new [] { "allowedAnalyses" },

                                 // the properties below are optional
                                 AdditionalAnalyses = "additionalAnalyses",
                                 AllowedAnalysisProviders = new [] { "allowedAnalysisProviders" },
                                 DifferentialPrivacy = new DifferentialPrivacyProperty {
                                     Columns = new [] { new DifferentialPrivacyColumnProperty {
                                         Name = "name"
                                     } }
                                 },
                                 DisallowedOutputColumns = new [] { "disallowedOutputColumns" }
                             },
                             List = new AnalysisRuleListProperty {
                                 JoinColumns = new [] { "joinColumns" },
                                 ListColumns = new [] { "listColumns" },

                                 // the properties below are optional
                                 AdditionalAnalyses = "additionalAnalyses",
                                 AllowedJoinOperators = new [] { "allowedJoinOperators" }
                             }
                         }
                     },
                     Type = "type"
                 } },
                 Description = "description",
                 SelectedAnalysisMethods = new [] { "selectedAnalysisMethods" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

AllowedColumns	The columns within the underlying AWS Glue table that can be utilized within collaborations.
AnalysisMethod	The analysis method for the configured table.
AnalysisRules	The analysis rule that was created for the configured table.
Description	A description for the configured table.
Name	A name for the configured table.
SelectedAnalysisMethods	The selected analysis methods for the configured table.
TableReference	The table that this configured table represents.
Tags	An optional label that you can assign to a resource when you create it.

Properties

AllowedColumns

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

string[] AllowedColumns { get; }

Property Value

string[]

Remarks

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

AnalysisMethod

The analysis method for the configured table.

string AnalysisMethod { get; }

Property Value

string

Remarks

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

AnalysisRules

The analysis rule that was created for the configured table.

object? AnalysisRules { get; }

Property Value

object

Remarks

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.

string? Description { get; }

Property Value

string

Remarks

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.

string Name { get; }

Property Value

string

Remarks

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

SelectedAnalysisMethods

The selected analysis methods for the configured table.

string[]? SelectedAnalysisMethods { get; }

Property Value

string[]

Remarks

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

TableReference

The table that this configured table represents.

object TableReference { get; }

Property Value

object

Remarks

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