Package software.amazon.awscdk.services.scn

Class CfnDataset

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.scn.CfnDataset
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDatasetRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:11.765Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable, IDatasetRef, ITaggableV2
Represents an AWS Supply Chain data lake dataset.

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.scn.*;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .instanceId("instanceId")
         .name("name")
         .namespace("namespace")
         // the properties below are optional
         .description("description")
         .partitionSpec(PartitionSpecProperty.builder()
                 .fields(List.of(DataLakeDatasetPartitionFieldProperty.builder()
                         .name("name")
                         .transform(TransformProperty.builder()
                                 .type("type")
                                 .build())
                         .build()))
                 .build())
         .schema(SchemaProperty.builder()
                 .fields(List.of(DataLakeDatasetSchemaFieldProperty.builder()
                         .isRequired(false)
                         .name("name")
                         .type("type")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .primaryKeys(List.of(DataLakeDatasetPrimaryKeyFieldProperty.builder()
                         .name("name")
                         .build()))
                 .build())
         .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

    • CfnDataset

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

    • CfnDataset

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

    • CfnDataset

      @Stability(Stable) public CfnDataset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDatasetProps props)
      Create a new AWS::SCN::Dataset.

      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

    • arnForDataset

      @Stability(Stable) @NotNull public static String arnForDataset(@NotNull IDatasetRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDataset

      @Stability(Stable) @NotNull public static Boolean isCfnDataset(@NotNull Object x)
      Checks whether the given object is a CfnDataset.

      Parameters:
      x - This parameter is required.

    • 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()
      The Amazon Resource Name (ARN) of the dataset.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The creation time of the dataset.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The last modified time of the 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

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getDatasetRef

      @Stability(Stable) @NotNull public DatasetReference getDatasetRef()
      A reference to a Dataset resource.
      Specified by:
      getDatasetRef in interface IDatasetRef

    • getInstanceId

      @Stability(Stable) @NotNull public String getInstanceId()
      The Amazon Web Services Supply Chain instance identifier.

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@NotNull String value)
      The Amazon Web Services Supply Chain instance identifier.

    • getName

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

    • setName

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

    • getNamespace

      @Stability(Stable) @NotNull public String getNamespace()
      The namespace of the dataset.

    • setNamespace

      @Stability(Stable) public void setNamespace(@NotNull String value)
      The namespace of the dataset.

    • getDescription

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

    • setDescription

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

    • getPartitionSpec

      @Stability(Stable) @Nullable public Object getPartitionSpec()
      The partition specification of the dataset.

      Returns union: either IResolvable or CfnDataset.PartitionSpecProperty

    • setPartitionSpec

      @Stability(Stable) public void setPartitionSpec(@Nullable IResolvable value)
      The partition specification of the dataset.

    • setPartitionSpec

      @Stability(Stable) public void setPartitionSpec(@Nullable CfnDataset.PartitionSpecProperty value)
      The partition specification of the dataset.

    • getSchema

      @Stability(Stable) @Nullable public Object getSchema()
      The schema of the dataset.

      Returns union: either IResolvable or CfnDataset.SchemaProperty

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable IResolvable value)
      The schema of the dataset.

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable CfnDataset.SchemaProperty value)
      The schema of the dataset.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the dataset.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the dataset.