Skip to content
v2.277.0

CfnAIWorkloadConfigProps Struct ​

Properties for defining a CfnAIWorkloadConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnAIWorkloadConfigProps: sagemaker.CfnAIWorkloadConfigProps = {
  aiWorkloadConfigName: 'aiWorkloadConfigName',

  // the properties below are optional
  aiWorkloadConfigs: {
    workloadSpec: {
      inline: 'inline',
    },
  },
  datasetConfig: {
    inputDataConfig: [{
      channelName: 'channelName',
      dataSource: {
        s3DataSource: {
          s3Uri: 's3Uri',
        },
      },
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_ai_workload_config_props = sagemaker.CfnAIWorkloadConfigProps(
    ai_workload_config_name="aiWorkloadConfigName",

    # the properties below are optional
    ai_workload_configs=sagemaker.CfnAIWorkloadConfig.AIWorkloadConfigsProperty(
        workload_spec=sagemaker.CfnAIWorkloadConfig.WorkloadSpecProperty(
            inline="inline"
        )
    ),
    dataset_config=sagemaker.CfnAIWorkloadConfig.AIDatasetConfigProperty(
        input_data_config=[sagemaker.CfnAIWorkloadConfig.AIWorkloadInputDataConfigProperty(
            channel_name="channelName",
            data_source=sagemaker.CfnAIWorkloadConfig.AIWorkloadDataSourceProperty(
                s3_data_source=sagemaker.CfnAIWorkloadConfig.AIWorkloadS3DataSourceProperty(
                    s3_uri="s3Uri"
                )
            )
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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.*;

CfnAIWorkloadConfigProps cfnAIWorkloadConfigProps = CfnAIWorkloadConfigProps.builder()
        .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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var cfnAIWorkloadConfigProps = new CfnAIWorkloadConfigProps {
    AiWorkloadConfigName = "aiWorkloadConfigName",

    // the properties below are optional
    AiWorkloadConfigs = new AIWorkloadConfigsProperty {
        WorkloadSpec = new WorkloadSpecProperty {
            Inline = "inline"
        }
    },
    DatasetConfig = new AIDatasetConfigProperty {
        InputDataConfig = new [] { new AIWorkloadInputDataConfigProperty {
            ChannelName = "channelName",
            DataSource = new AIWorkloadDataSourceProperty {
                S3DataSource = new AIWorkloadS3DataSourceProperty {
                    S3Uri = "s3Uri"
                }
            }
        } }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAIWorkloadConfigProps := &CfnAIWorkloadConfigProps{
	AiWorkloadConfigName: jsii.String("aiWorkloadConfigName"),

	// the properties below are optional
	AiWorkloadConfigs: &AIWorkloadConfigsProperty{
		WorkloadSpec: &WorkloadSpecProperty{
			Inline: jsii.String("inline"),
		},
	},
	DatasetConfig: &AIDatasetConfigProperty{
		InputDataConfig: []interface{}{
			&AIWorkloadInputDataConfigProperty{
				ChannelName: jsii.String("channelName"),
				DataSource: &AIWorkloadDataSourceProperty{
					S3DataSource: &AIWorkloadS3DataSourceProperty{
						S3Uri: jsii.String("s3Uri"),
					},
				},
			},
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

aiWorkloadConfigNamestringai_workload_config_namestraiWorkloadConfigNameStringAiWorkloadConfigNamestringAiWorkloadConfigName*string required #
The name of the AI workload configuration.
notes

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.

aiWorkloadConfigsoptionalIResolvable | CfnAIWorkloadConfig.AIWorkloadConfigsPropertyai_workload_configsoptionaltyping.Union[IResolvable, AIWorkloadConfigsProperty]aiWorkloadConfigsoptionalIResolvableAiWorkloadConfigsoptionalIResolvableAiWorkloadConfigsoptionalinterface{} #
The benchmark tool configuration for an AI workload.
datasetConfigoptionalIResolvable | CfnAIWorkloadConfig.AIDatasetConfigPropertydataset_configoptionaltyping.Union[IResolvable, AIDatasetConfigProperty]datasetConfigoptionalIResolvableDatasetConfigoptionalIResolvableDatasetConfigoptionalinterface{} #
The dataset configuration for an AI workload.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The metadata that you apply to the AI workload configuration to help you categorize and organize it.