Package software.amazon.awscdk.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
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-15T10:24:55.771Z") @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:

  • 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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • 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 analysis rule that was created for the configured table.

    • setAnalysisRules

      @Stability(Stable) public void setAnalysisRules(@Nullable IResolvable value)
      The analysis rule that was created for the configured table.

    • setAnalysisRules

      @Stability(Stable) public void setAnalysisRules(@Nullable List<Object> value)
      The analysis rule that was created for the configured table.

    • 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.