1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. AiWorkloadConfig

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi

    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.

    Create AiWorkloadConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiWorkloadConfig(name: string, args?: AiWorkloadConfigArgs, opts?: CustomResourceOptions);
    @overload
    def AiWorkloadConfig(resource_name: str,
                         args: Optional[AiWorkloadConfigArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AiWorkloadConfig(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ai_workload_config_name: Optional[str] = None,
                         ai_workload_configs: Optional[AiWorkloadConfigAiWorkloadConfigsArgs] = None,
                         dataset_config: Optional[AiWorkloadConfigAiDatasetConfigArgs] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewAiWorkloadConfig(ctx *Context, name string, args *AiWorkloadConfigArgs, opts ...ResourceOption) (*AiWorkloadConfig, error)
    public AiWorkloadConfig(string name, AiWorkloadConfigArgs? args = null, CustomResourceOptions? opts = null)
    public AiWorkloadConfig(String name, AiWorkloadConfigArgs args)
    public AiWorkloadConfig(String name, AiWorkloadConfigArgs args, CustomResourceOptions options)
    
    type: aws-native:sagemaker:AiWorkloadConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_sagemaker_ai_workload_config" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AiWorkloadConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiWorkloadConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiWorkloadConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiWorkloadConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiWorkloadConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AiWorkloadConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiWorkloadConfig resource accepts the following input properties:

    AiWorkloadConfigName string
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    AiWorkloadConfigs Pulumi.AwsNative.SageMaker.Inputs.AiWorkloadConfigAiWorkloadConfigs
    The benchmark tool configuration and workload specification.
    DatasetConfig Pulumi.AwsNative.SageMaker.Inputs.AiWorkloadConfigAiDatasetConfig
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    AiWorkloadConfigName string
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    AiWorkloadConfigs AiWorkloadConfigAiWorkloadConfigsArgs
    The benchmark tool configuration and workload specification.
    DatasetConfig AiWorkloadConfigAiDatasetConfigArgs
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    Tags TagArgs
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    ai_workload_config_name string
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    ai_workload_configs object
    The benchmark tool configuration and workload specification.
    dataset_config object
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    tags list(object)
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    aiWorkloadConfigName String
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    aiWorkloadConfigs AiWorkloadConfigAiWorkloadConfigs
    The benchmark tool configuration and workload specification.
    datasetConfig AiWorkloadConfigAiDatasetConfig
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    tags List<Tag>
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    aiWorkloadConfigName string
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    aiWorkloadConfigs AiWorkloadConfigAiWorkloadConfigs
    The benchmark tool configuration and workload specification.
    datasetConfig AiWorkloadConfigAiDatasetConfig
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    tags Tag[]
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    ai_workload_config_name str
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    ai_workload_configs AiWorkloadConfigAiWorkloadConfigsArgs
    The benchmark tool configuration and workload specification.
    dataset_config AiWorkloadConfigAiDatasetConfigArgs
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    tags Sequence[TagArgs]
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.
    aiWorkloadConfigName String
    The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region. Only lowercase letters and digits are accepted: DeleteAIWorkloadConfig lowercases the name before looking it up, so a name containing an uppercase letter produces a configuration that can be created and read but never deleted.
    aiWorkloadConfigs Property Map
    The benchmark tool configuration and workload specification.
    datasetConfig Property Map
    The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
    tags List<Property Map>
    The metadata that you apply to the AI workload configuration to help you categorize and organize it.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiWorkloadConfig resource produces the following output properties:

    AiWorkloadConfigArn string
    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.
    CreationTime string
    A timestamp that indicates when the AI workload configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    AiWorkloadConfigArn string
    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.
    CreationTime string
    A timestamp that indicates when the AI workload configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ai_workload_config_arn string
    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.
    creation_time string
    A timestamp that indicates when the AI workload configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    aiWorkloadConfigArn String
    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.
    creationTime String
    A timestamp that indicates when the AI workload configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    aiWorkloadConfigArn string
    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.
    creationTime string
    A timestamp that indicates when the AI workload configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    ai_workload_config_arn str
    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.
    creation_time str
    A timestamp that indicates when the AI workload configuration was created.
    id str
    The provider-assigned unique ID for this managed resource.
    aiWorkloadConfigArn String
    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.
    creationTime String
    A timestamp that indicates when the AI workload configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AiWorkloadConfigAiDatasetConfig, AiWorkloadConfigAiDatasetConfigArgs

    The dataset configuration for an AI workload.
    InputDataConfig List<Pulumi.AwsNative.SageMaker.Inputs.AiWorkloadConfigAiWorkloadInputDataConfig>
    An array of input data channel configurations for the workload.
    InputDataConfig []AiWorkloadConfigAiWorkloadInputDataConfig
    An array of input data channel configurations for the workload.
    input_data_config list(object)
    An array of input data channel configurations for the workload.
    inputDataConfig List<AiWorkloadConfigAiWorkloadInputDataConfig>
    An array of input data channel configurations for the workload.
    inputDataConfig AiWorkloadConfigAiWorkloadInputDataConfig[]
    An array of input data channel configurations for the workload.
    input_data_config Sequence[AiWorkloadConfigAiWorkloadInputDataConfig]
    An array of input data channel configurations for the workload.
    inputDataConfig List<Property Map>
    An array of input data channel configurations for the workload.

    AiWorkloadConfigAiWorkloadConfigs, AiWorkloadConfigAiWorkloadConfigsArgs

    The benchmark tool configuration for an AI workload.
    WorkloadSpec Pulumi.AwsNative.SageMaker.Inputs.AiWorkloadConfigWorkloadSpec
    The workload specification that defines benchmark parameters.
    WorkloadSpec AiWorkloadConfigWorkloadSpec
    The workload specification that defines benchmark parameters.
    workload_spec object
    The workload specification that defines benchmark parameters.
    workloadSpec AiWorkloadConfigWorkloadSpec
    The workload specification that defines benchmark parameters.
    workloadSpec AiWorkloadConfigWorkloadSpec
    The workload specification that defines benchmark parameters.
    workload_spec AiWorkloadConfigWorkloadSpec
    The workload specification that defines benchmark parameters.
    workloadSpec Property Map
    The workload specification that defines benchmark parameters.

    AiWorkloadConfigAiWorkloadDataSource, AiWorkloadConfigAiWorkloadDataSourceArgs

    The data source for an AI workload input data channel.
    S3DataSource AiWorkloadConfigAiWorkloadS3DataSource
    The Amazon S3 data source configuration.
    s3_data_source object
    The Amazon S3 data source configuration.
    s3DataSource AiWorkloadConfigAiWorkloadS3DataSource
    The Amazon S3 data source configuration.
    s3DataSource AiWorkloadConfigAiWorkloadS3DataSource
    The Amazon S3 data source configuration.
    s3_data_source AiWorkloadConfigAiWorkloadS3DataSource
    The Amazon S3 data source configuration.
    s3DataSource Property Map
    The Amazon S3 data source configuration.

    AiWorkloadConfigAiWorkloadInputDataConfig, AiWorkloadConfigAiWorkloadInputDataConfigArgs

    A channel of input data for an AI workload configuration.
    ChannelName string
    The logical name for the data channel.
    DataSource Pulumi.AwsNative.SageMaker.Inputs.AiWorkloadConfigAiWorkloadDataSource
    The data source for this channel.
    ChannelName string
    The logical name for the data channel.
    DataSource AiWorkloadConfigAiWorkloadDataSource
    The data source for this channel.
    channel_name string
    The logical name for the data channel.
    data_source object
    The data source for this channel.
    channelName String
    The logical name for the data channel.
    dataSource AiWorkloadConfigAiWorkloadDataSource
    The data source for this channel.
    channelName string
    The logical name for the data channel.
    dataSource AiWorkloadConfigAiWorkloadDataSource
    The data source for this channel.
    channel_name str
    The logical name for the data channel.
    data_source AiWorkloadConfigAiWorkloadDataSource
    The data source for this channel.
    channelName String
    The logical name for the data channel.
    dataSource Property Map
    The data source for this channel.

    AiWorkloadConfigAiWorkloadS3DataSource, AiWorkloadConfigAiWorkloadS3DataSourceArgs

    The Amazon S3 data source for an AI workload.
    S3Uri string
    The Amazon S3 URI of the data.
    S3Uri string
    The Amazon S3 URI of the data.
    s3_uri string
    The Amazon S3 URI of the data.
    s3Uri String
    The Amazon S3 URI of the data.
    s3Uri string
    The Amazon S3 URI of the data.
    s3_uri str
    The Amazon S3 URI of the data.
    s3Uri String
    The Amazon S3 URI of the data.

    AiWorkloadConfigWorkloadSpec, AiWorkloadConfigWorkloadSpecArgs

    The workload specification for benchmark tool configuration.
    Inline string
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    Inline string
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    inline string
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    inline String
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    inline string
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    inline str
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.
    inline String
    An inline YAML or JSON string that defines benchmark parameters. The service validates the document against its own benchmark schema: it must declare a benchmark object whose type member matches the pattern ^(aiperf)$.

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial