Package services.cleanrooms

Class CfnConfiguredTable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

services.cleanrooms.CfnConfiguredTable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:05.006Z")
@Stability(Stable)
public class CfnConfiguredTable
extends CfnResource
implements IInspectable

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 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
                                         .allowedJoinOperators(List.of("allowedJoinOperators"))
                                         .joinRequired("joinRequired")
                                         .build())
                                 .custom(AnalysisRuleCustomProperty.builder()
                                         .allowedAnalyses(List.of("allowedAnalyses"))
                                         // the properties below are optional
                                         .allowedAnalysisProviders(List.of("allowedAnalysisProviders"))
                                         .build())
                                 .list(AnalysisRuleListProperty.builder()
                                         .joinColumns(List.of("joinColumns"))
                                         .listColumns(List.of("listColumns"))
                                         // the properties below are optional
                                         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConfiguredTable.AggregateColumnProperty	Column in configured table that can be used in aggregate function in query.
static interface	CfnConfiguredTable.AggregationConstraintProperty	Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
static interface	CfnConfiguredTable.AnalysisRuleAggregationProperty	A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
static interface	CfnConfiguredTable.AnalysisRuleCustomProperty	A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.
static interface	CfnConfiguredTable.AnalysisRuleListProperty	A type of analysis rule that enables row-level analysis.
static interface	CfnConfiguredTable.AnalysisRuleProperty	A specification about how data from the configured table can be used in a query.
static final class	CfnConfiguredTable.Builder	A fluent builder for CfnConfiguredTable.
static interface	CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyProperty	Controls on the query specifications that can be run on a configured table.
static interface	CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyV1Property	Controls on the query specifications that can be run on a configured table.
static interface	CfnConfiguredTable.GlueTableReferenceProperty	A reference to a table within an AWS Glue data catalog.
static interface	CfnConfiguredTable.TableReferenceProperty	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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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 Type	Method	Description
List<String>	getAllowedColumns()	The columns within the underlying AWS Glue table that can be utilized within collaborations.
String	getAnalysisMethod()	The analysis method for the configured table.
Object	getAnalysisRules()	The entire created analysis rule.
String	getAttrArn()	Returns the Amazon Resource Name (ARN) of the specified configured table.
String	getAttrConfiguredTableIdentifier()	Returns the unique identifier of the specified configured table.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description for the configured table.
String	getName()	A name for the configured table.
Object	getTableReference()	The AWS Glue table that this configured table represents.
List<CfnTag>	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.
protected Map<String,Object>	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 entire created analysis rule.
void	setAnalysisRules(IResolvable value)	The entire created analysis rule.
void	setDescription(String value)	A description for the configured table.
void	setName(String value)	A name for the configured table.
void	setTableReference(CfnConfiguredTable.TableReferenceProperty value)	The AWS Glue table that this configured table represents.
void	setTableReference(IResolvable value)	The AWS Glue table that this configured table represents.
void	setTags(List<CfnTag> value)	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

@Stability(Stable)
public static final String 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String 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

@Stability(Stable)
@NotNull
public String getAttrConfiguredTableIdentifier()

Returns the unique identifier of the specified configured table.

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAllowedColumns

@Stability(Stable)
@NotNull
public List<String> getAllowedColumns()

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

setAllowedColumns

@Stability(Stable)
public void setAllowedColumns(@NotNull
 List<String> value)

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

getAnalysisMethod

@Stability(Stable)
@NotNull
public String getAnalysisMethod()

The analysis method for the configured table.

setAnalysisMethod

@Stability(Stable)
public void setAnalysisMethod(@NotNull
 String value)

The analysis method for the configured table.

getName

@Stability(Stable)
@NotNull
public String getName()

A name for the configured table.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

A name for the configured table.

getTableReference

@Stability(Stable)
@NotNull
public Object getTableReference()

The AWS Glue table that this configured table represents.

setTableReference

@Stability(Stable)
public void setTableReference(@NotNull
 IResolvable value)

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

@Stability(Stable)
@Nullable
public Object getAnalysisRules()

The entire created analysis rule.

setAnalysisRules

@Stability(Stable)
public void setAnalysisRules(@Nullable
 IResolvable value)

The entire created analysis rule.

setAnalysisRules

@Stability(Stable)
public void setAnalysisRules(@Nullable
 List<Object> value)

The entire created analysis rule.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description for the configured table.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description for the configured table.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

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