Class CfnConfiguredTable
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanrooms.CfnConfiguredTable
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:23:58.041Z")
@Stability(Stable)
public class CfnConfiguredTable
extends CfnResource
implements IInspectable, ITaggableV2
Creates a new configured table resource.
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.*; CfnConfiguredTable cfnConfiguredTable = CfnConfiguredTable.Builder.create(this, "MyCfnConfiguredTable") .allowedColumns(List.of("allowedColumns")) .analysisMethod("analysisMethod") .name("name") .tableReference(TableReferenceProperty.builder() .glue(GlueTableReferenceProperty.builder() .databaseName("databaseName") .tableName("tableName") .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") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Column in configured table that can be used in aggregate function in query.static interface
Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.static interface
A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.static interface
A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.static interface
A type of analysis rule that enables row-level analysis.static interface
A specification about how data from the configured table can be used in a query.static final class
A fluent builder forCfnConfiguredTable
.static interface
Controls on the query specifications that can be run on a configured table.static interface
Controls on the query specifications that can be run on a configured table.static interface
Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.static interface
The analysis method for the configured tables.static interface
A reference to a table within an AWS Glue data catalog.static interface
A pointer to the dataset that underlies this table.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnConfiguredTable
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnConfiguredTable
(software.amazon.jsii.JsiiObjectRef objRef) CfnConfiguredTable
(software.constructs.Construct scope, String id, CfnConfiguredTableProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe columns within the underlying AWS Glue table that can be utilized within collaborations.The analysis method for the configured table.The analysis rule that was created for the configured table.Returns the Amazon Resource Name (ARN) of the specified configured table.Returns the unique identifier of the specified configured table.Tag Manager which manages the tags for this resource.A description for the configured table.getName()
A name for the configured table.The AWS Glue table that this configured table represents.getTags()
An optional label that you can assign to a resource when you create it.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAllowedColumns
(List<String> value) The columns within the underlying AWS Glue table that can be utilized within collaborations.void
setAnalysisMethod
(String value) The analysis method for the configured table.void
setAnalysisRules
(List<Object> value) The analysis rule that was created for the configured table.void
setAnalysisRules
(IResolvable value) The analysis rule that was created for the configured table.void
setDescription
(String value) A description for the configured table.void
A name for the configured table.void
setTableReference
(IResolvable value) The AWS Glue table that this configured table represents.void
The AWS Glue table that this configured table represents.void
An optional label that you can assign to a resource when you create it.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnConfiguredTable
protected CfnConfiguredTable(software.amazon.jsii.JsiiObjectRef objRef) -
CfnConfiguredTable
protected CfnConfiguredTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnConfiguredTable
@Stability(Stable) public CfnConfiguredTable(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfiguredTableProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
Returns the Amazon Resource Name (ARN) of the specified configured table.Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
-
getAttrConfiguredTableIdentifier
Returns the unique identifier of the specified configured table.Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAllowedColumns
The columns within the underlying AWS Glue table that can be utilized within collaborations. -
setAllowedColumns
The columns within the underlying AWS Glue table that can be utilized within collaborations. -
getAnalysisMethod
The analysis method for the configured table. -
setAnalysisMethod
The analysis method for the configured table. -
getName
A name for the configured table. -
setName
A name for the configured table. -
getTableReference
The AWS Glue table that this configured table represents. -
setTableReference
The AWS Glue table that this configured table represents. -
setTableReference
@Stability(Stable) public void setTableReference(@NotNull CfnConfiguredTable.TableReferenceProperty value) The AWS Glue table that this configured table represents. -
getAnalysisRules
The analysis rule that was created for the configured table. -
setAnalysisRules
The analysis rule that was created for the configured table. -
setAnalysisRules
The analysis rule that was created for the configured table. -
getDescription
A description for the configured table. -
setDescription
A description for the configured table. -
getTags
An optional label that you can assign to a resource when you create it. -
setTags
An optional label that you can assign to a resource when you create it.
-