Package software.amazon.awscdk.services.bedrockagentcore

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.bedrockagentcore.CfnDataset
All Implemented Interfaces:
IInspectable, IDatasetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)", date="2026-06-11T16:21:36.787Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable, IDatasetRef, ITaggableV2
Definition of AWS::BedrockAgentCore::Dataset Resource Type.

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.bedrockagentcore.*;
 Object examples;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .datasetName("datasetName")
         .schemaType("schemaType")
         // the properties below are optional
         .description("description")
         .kmsKeyArn("kmsKeyArn")
         .source(DataSourceTypeProperty.builder()
                 .inlineExamples(InlineExamplesSourceProperty.builder()
                         .examples(List.of(examples))
                         .build())
                 .s3Source(S3SourceProperty.builder()
                         .s3Uri("s3Uri")
                         .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::BedrockAgentCore::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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the dataset was created.

    • getAttrDatasetArn

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

    • getAttrDatasetId

      @Stability(Stable) @NotNull public String getAttrDatasetId()
      The unique identifier of the dataset.

    • getAttrExampleCount

      @Stability(Stable) @NotNull public Number getAttrExampleCount()
      The number of examples in the dataset DRAFT.

    • getAttrStatus

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

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the dataset was last updated.

    • 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

    • getDatasetName

      @Stability(Stable) @NotNull public String getDatasetName()
      Human-readable name for the dataset.

    • setDatasetName

      @Stability(Stable) public void setDatasetName(@NotNull String value)
      Human-readable name for the dataset.

    • getSchemaType

      @Stability(Stable) @NotNull public String getSchemaType()
      Versioned schema type governing the structure of examples.

    • setSchemaType

      @Stability(Stable) public void setSchemaType(@NotNull String value)
      Versioned schema type governing the structure of examples.

    • getDescription

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

    • setDescription

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

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      Optional AWS KMS key ARN for SSE-KMS on service S3 writes.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      Optional AWS KMS key ARN for SSE-KMS on service S3 writes.

    • getSource

      @Stability(Stable) @Nullable public Object getSource()
      Source of initial examples.

      Returns union: either IResolvable or CfnDataset.DataSourceTypeProperty

    • setSource

      @Stability(Stable) public void setSource(@Nullable IResolvable value)
      Source of initial examples.

    • setSource

      @Stability(Stable) public void setSource(@Nullable CfnDataset.DataSourceTypeProperty value)
      Source of initial examples.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to assign to the dataset.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to assign to the dataset.