Interface CfnConfiguredTableProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConfiguredTableProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-20T23:37:16.057Z")
@Stability(Stable)
public interface CfnConfiguredTableProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnConfiguredTable.
Example:
// 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.*;
CfnConfiguredTableProps cfnConfiguredTableProps = CfnConfiguredTableProps.builder()
.allowedColumns(List.of("allowedColumns"))
.analysisMethod("analysisMethod")
.name("name")
.tableReference(TableReferenceProperty.builder()
.athena(AthenaTableReferenceProperty.builder()
.databaseName("databaseName")
.tableName("tableName")
.workGroup("workGroup")
// the properties below are optional
.outputLocation("outputLocation")
.region("region")
.build())
.glue(GlueTableReferenceProperty.builder()
.databaseName("databaseName")
.tableName("tableName")
// the properties below are optional
.region("region")
.build())
.snowflake(SnowflakeTableReferenceProperty.builder()
.accountIdentifier("accountIdentifier")
.databaseName("databaseName")
.schemaName("schemaName")
.secretArn("secretArn")
.tableName("tableName")
.tableSchema(SnowflakeTableSchemaProperty.builder()
.v1(List.of(SnowflakeTableSchemaV1Property.builder()
.columnName("columnName")
.columnType("columnType")
.build()))
.build())
.build())
.build())
// the properties below are optional
.analysisRules(List.of(AnalysisRuleProperty.builder()
.policy(ConfiguredTableAnalysisRulePolicyProperty.builder()
.v1(ConfiguredTableAnalysisRulePolicyV1Property.builder()
.aggregation(AnalysisRuleAggregationProperty.builder()
.aggregateColumns(List.of(AggregateColumnProperty.builder()
.columnNames(List.of("columnNames"))
.function("function")
.build()))
.dimensionColumns(List.of("dimensionColumns"))
.joinColumns(List.of("joinColumns"))
.outputConstraints(List.of(AggregationConstraintProperty.builder()
.columnName("columnName")
.minimum(123)
.type("type")
.build()))
.scalarFunctions(List.of("scalarFunctions"))
// the properties below are optional
.additionalAnalyses("additionalAnalyses")
.allowedJoinOperators(List.of("allowedJoinOperators"))
.joinRequired("joinRequired")
.build())
.custom(AnalysisRuleCustomProperty.builder()
.allowedAnalyses(List.of("allowedAnalyses"))
// the properties below are optional
.additionalAnalyses("additionalAnalyses")
.allowedAnalysisProviders(List.of("allowedAnalysisProviders"))
.differentialPrivacy(DifferentialPrivacyProperty.builder()
.columns(List.of(DifferentialPrivacyColumnProperty.builder()
.name("name")
.build()))
.build())
.disallowedOutputColumns(List.of("disallowedOutputColumns"))
.build())
.list(AnalysisRuleListProperty.builder()
.joinColumns(List.of("joinColumns"))
.listColumns(List.of("listColumns"))
// the properties below are optional
.additionalAnalyses("additionalAnalyses")
.allowedJoinOperators(List.of("allowedJoinOperators"))
.build())
.build())
.build())
.type("type")
.build()))
.description("description")
.selectedAnalysisMethods(List.of("selectedAnalysisMethods"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnConfiguredTablePropsstatic final classAn implementation forCfnConfiguredTableProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The columns within the underlying AWS Glue table that can be used within collaborations.The analysis method for the configured table.default ObjectThe analysis rule that was created for the configured table.default StringA description for the configured table.getName()A name for the configured table.The selected analysis methods for the configured table.The table that this configured table represents.getTags()An optional label that you can assign to a resource when you create it.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllowedColumns
The columns within the underlying AWS Glue table that can be used within collaborations.- See Also:
-
getAnalysisMethod
The analysis method for the configured table.DIRECT_QUERYallows SQL queries to be run directly on this table.DIRECT_JOBallows PySpark jobs to be run directly on this table.MULTIPLEallows both SQL queries and PySpark jobs to be run directly on this table.- See Also:
-
getName
A name for the configured table.- See Also:
-
getTableReference
The table that this configured table represents.Returns union: either
IResolvableorCfnConfiguredTable.TableReferenceProperty- See Also:
-
getAnalysisRules
The analysis rule that was created for the configured table.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnConfiguredTable.AnalysisRuleProperty>- See Also:
-
getDescription
A description for the configured table.- See Also:
-
getSelectedAnalysisMethods
The selected analysis methods for the configured table.- See Also:
-
getTags
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 Also:
-
builder
- Returns:
- a
CfnConfiguredTableProps.BuilderofCfnConfiguredTableProps
-