Package software.amazon.awscdk.services.sagemaker

Class CfnAIWorkloadConfig

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.sagemaker.CfnAIWorkloadConfig
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAIWorkloadConfigRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:05:00.534Z") @Stability(Stable) public class CfnAIWorkloadConfig extends CfnResource implements IInspectable, IAIWorkloadConfigRef, ITaggableV2
Resource Type definition for AWS::SageMaker::AIWorkloadConfig.

A reusable AI workload configuration that defines datasets, data sources and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.

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.sagemaker.*;
 CfnAIWorkloadConfig cfnAIWorkloadConfig = CfnAIWorkloadConfig.Builder.create(this, "MyCfnAIWorkloadConfig")
         .aiWorkloadConfigName("aiWorkloadConfigName")
         // the properties below are optional
         .aiWorkloadConfigs(AIWorkloadConfigsProperty.builder()
                 .workloadSpec(WorkloadSpecProperty.builder()
                         .inline("inline")
                         .build())
                 .build())
         .datasetConfig(AIDatasetConfigProperty.builder()
                 .inputDataConfig(List.of(AIWorkloadInputDataConfigProperty.builder()
                         .channelName("channelName")
                         .dataSource(AIWorkloadDataSourceProperty.builder()
                                 .s3DataSource(AIWorkloadS3DataSourceProperty.builder()
                                         .s3Uri("s3Uri")
                                         .build())
                                 .build())
                         .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

    • CfnAIWorkloadConfig

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

    • CfnAIWorkloadConfig

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

    • CfnAIWorkloadConfig

      @Stability(Stable) public CfnAIWorkloadConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAIWorkloadConfigProps props)
      Create a new AWS::SageMaker::AIWorkloadConfig.

      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

    • arnForAIWorkloadConfig

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

    • isCfnAIWorkloadConfig

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

      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.

    • getAiWorkloadConfigRef

      @Stability(Stable) @NotNull public AIWorkloadConfigReference getAiWorkloadConfigRef()
      A reference to a AIWorkloadConfig resource.
      Specified by:
      getAiWorkloadConfigRef in interface IAIWorkloadConfigRef

    • getAttrAiWorkloadConfigArn

      @Stability(Stable) @NotNull public String getAttrAiWorkloadConfigArn()
      The Amazon Resource Name (ARN) of the AI workload configuration.

      The name segment is restricted to lowercase for the same reason as AIWorkloadConfigName: the engine derives that property from this ARN, so a permissive ARN would yield a derived name the schema itself rejects.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      A timestamp that indicates when the AI workload configuration was created.

    • 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

    • getAiWorkloadConfigName

      @Stability(Stable) @NotNull public String getAiWorkloadConfigName()
      The name of the AI workload configuration.

    • setAiWorkloadConfigName

      @Stability(Stable) public void setAiWorkloadConfigName(@NotNull String value)
      The name of the AI workload configuration.

    • getAiWorkloadConfigs

      @Stability(Stable) @Nullable public Object getAiWorkloadConfigs()
      The benchmark tool configuration for an AI workload.

      Returns union: either IResolvable or CfnAIWorkloadConfig.AIWorkloadConfigsProperty

    • setAiWorkloadConfigs

      @Stability(Stable) public void setAiWorkloadConfigs(@Nullable IResolvable value)
      The benchmark tool configuration for an AI workload.

    • setAiWorkloadConfigs

      @Stability(Stable) public void setAiWorkloadConfigs(@Nullable CfnAIWorkloadConfig.AIWorkloadConfigsProperty value)
      The benchmark tool configuration for an AI workload.

    • getDatasetConfig

      @Stability(Stable) @Nullable public Object getDatasetConfig()
      The dataset configuration for an AI workload.

      Returns union: either IResolvable or CfnAIWorkloadConfig.AIDatasetConfigProperty

    • setDatasetConfig

      @Stability(Stable) public void setDatasetConfig(@Nullable IResolvable value)
      The dataset configuration for an AI workload.

    • setDatasetConfig

      @Stability(Stable) public void setDatasetConfig(@Nullable CfnAIWorkloadConfig.AIDatasetConfigProperty value)
      The dataset configuration for an AI workload.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The metadata that you apply to the AI workload configuration to help you categorize and organize it.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The metadata that you apply to the AI workload configuration to help you categorize and organize it.