Package software.amazon.awscdk.services.cleanroomsml

Class CfnTrainingDataset

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.cleanroomsml.CfnTrainingDataset
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.077Z") @Stability(Stable) public class CfnTrainingDataset extends CfnResource implements IInspectable, ITaggableV2
Defines the information necessary to create a training dataset.

In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

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.cleanroomsml.*;
 CfnTrainingDataset cfnTrainingDataset = CfnTrainingDataset.Builder.create(this, "MyCfnTrainingDataset")
         .name("name")
         .roleArn("roleArn")
         .trainingData(List.of(DatasetProperty.builder()
                 .inputConfig(DatasetInputConfigProperty.builder()
                         .dataSource(DataSourceProperty.builder()
                                 .glueDataSource(GlueDataSourceProperty.builder()
                                         .databaseName("databaseName")
                                         .tableName("tableName")
                                         // the properties below are optional
                                         .catalogId("catalogId")
                                         .build())
                                 .build())
                         .schema(List.of(ColumnSchemaProperty.builder()
                                 .columnName("columnName")
                                 .columnTypes(List.of("columnTypes"))
                                 .build()))
                         .build())
                 .type("type")
                 .build()))
         // the properties below are optional
         .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

    • CfnTrainingDataset

      protected CfnTrainingDataset(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTrainingDataset

      protected CfnTrainingDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTrainingDataset

      @Stability(Stable) public CfnTrainingDataset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTrainingDatasetProps 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.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the training dataset.

    • getAttrTrainingDatasetArn

      @Stability(Stable) @NotNull public String getAttrTrainingDatasetArn()
      The Amazon Resource Name (ARN) of the training dataset.

    • 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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the training dataset.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the training dataset.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

    • getTrainingData

      @Stability(Stable) @NotNull public Object getTrainingData()
      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

    • setTrainingData

      @Stability(Stable) public void setTrainingData(@NotNull IResolvable value)
      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

    • setTrainingData

      @Stability(Stable) public void setTrainingData(@NotNull List<Object> value)
      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the training dataset.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the training dataset.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The optional metadata that you apply to the resource to help you categorize and organize them.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The optional metadata that you apply to the resource to help you categorize and organize them.