primaryContainerIContainerDefinitionprimary_containerIContainerDefinitionprimaryContainerIContainerDefinitionPrimaryContainerIContainerDefinitionPrimaryContainerIContainerDefinition required #Properties for creating an Amazon SageMaker model using JSONPath.
| Source | aws-stepfunctions-tasks/lib/sagemaker/create-model.ts |
|---|---|
| Type last changed | v2.178.0 · 6 Feb 2025 |
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
declare const assign: any;
declare const containerDefinition: stepfunctions_tasks.ContainerDefinition;
declare const resultSelector: any;
declare const role: iam.Role;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
declare const vpc: ec2.Vpc;
const sageMakerCreateModelJsonPathProps: stepfunctions_tasks.SageMakerCreateModelJsonPathProps = {
modelName: 'modelName',
primaryContainer: containerDefinition,
// the properties below are optional
assign: {
assignKey: assign,
},
comment: 'comment',
containers: [containerDefinition],
credentials: {
role: taskRole,
},
enableNetworkIsolation: false,
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
outputPath: 'outputPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
role: role,
stateName: 'stateName',
subnetSelection: {
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
},
tags: taskInput,
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
vpc: vpc,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_iam as iam
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# assign: Any
# container_definition: stepfunctions_tasks.ContainerDefinition
# result_selector: Any
# role: iam.Role
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# task_input: stepfunctions.TaskInput
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
# vpc: ec2.Vpc
sage_maker_create_model_json_path_props = stepfunctions_tasks.SageMakerCreateModelJsonPathProps(
model_name="modelName",
primary_container=container_definition,
# the properties below are optional
assign={
"assign_key": assign
},
comment="comment",
containers=[container_definition],
credentials=stepfunctions.Credentials(
role=task_role
),
enable_network_isolation=False,
heartbeat=cdk.Duration.minutes(30),
heartbeat_timeout=timeout,
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
output_path="outputPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
role=role,
state_name="stateName",
subnet_selection=ec2.SubnetSelection(
availability_zones=["availabilityZones"],
one_per_az=False,
subnet_filters=[subnet_filter],
subnet_group_name="subnetGroupName",
subnets=[subnet],
subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
),
tags=task_input,
task_timeout=timeout,
timeout=cdk.Duration.minutes(30),
vpc=vpc
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Object assign;
ContainerDefinition containerDefinition;
Object resultSelector;
Role role;
Subnet subnet;
SubnetFilter subnetFilter;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
Vpc vpc;
SageMakerCreateModelJsonPathProps sageMakerCreateModelJsonPathProps = SageMakerCreateModelJsonPathProps.builder()
.modelName("modelName")
.primaryContainer(containerDefinition)
// the properties below are optional
.assign(Map.of(
"assignKey", assign))
.comment("comment")
.containers(List.of(containerDefinition))
.credentials(Credentials.builder()
.role(taskRole)
.build())
.enableNetworkIsolation(false)
.heartbeat(Duration.minutes(30))
.heartbeatTimeout(timeout)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.outputPath("outputPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.role(role)
.stateName("stateName")
.subnetSelection(SubnetSelection.builder()
.availabilityZones(List.of("availabilityZones"))
.onePerAz(false)
.subnetFilters(List.of(subnetFilter))
.subnetGroupName("subnetGroupName")
.subnets(List.of(subnet))
.subnetType(SubnetType.PRIVATE_ISOLATED)
.build())
.tags(taskInput)
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.vpc(vpc)
.build();
// 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;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
ContainerDefinition containerDefinition;
var resultSelector;
Role role;
Subnet subnet;
SubnetFilter subnetFilter;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
Vpc vpc;
var sageMakerCreateModelJsonPathProps = new SageMakerCreateModelJsonPathProps {
ModelName = "modelName",
PrimaryContainer = containerDefinition,
// the properties below are optional
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Containers = new [] { containerDefinition },
Credentials = new Credentials {
Role = taskRole
},
EnableNetworkIsolation = false,
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
Role = role,
StateName = "stateName",
SubnetSelection = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
},
Tags = taskInput,
TaskTimeout = timeout,
Timeout = Duration.Minutes(30),
Vpc = vpc
};
// 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"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var assign interface{}
var containerDefinition ContainerDefinition
var resultSelector interface{}
var role Role
var subnet Subnet
var subnetFilter SubnetFilter
var taskInput TaskInput
var taskRole TaskRole
var timeout Timeout
var vpc Vpc
sageMakerCreateModelJsonPathProps := &SageMakerCreateModelJsonPathProps{
ModelName: jsii.String("modelName"),
PrimaryContainer: containerDefinition,
// the properties below are optional
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
Containers: []IContainerDefinition{
containerDefinition,
},
Credentials: &Credentials{
Role: taskRole,
},
EnableNetworkIsolation: jsii.Boolean(false),
Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
HeartbeatTimeout: timeout,
InputPath: jsii.String("inputPath"),
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
OutputPath: jsii.String("outputPath"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
Role: role,
StateName: jsii.String("stateName"),
SubnetSelection: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []SubnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []ISubnet{
subnet,
},
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
Tags: taskInput,
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
Vpc: vpc,
}
assign?optional{ [key: string]: any }assign?optionaltyping.Mapping[str, Any]assign?optionalMap<String, Object>Assign?optionalIDictionary<string, object>Assign?optional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
comment?optionalstringcomment?optionalstrcomment?optionalStringComment?optionalstringComment?optional*string #Default: No comment
containers?optionalIContainerDefinition[]containers?optionaltyping.List[IContainerDefinition]containers?optionalList<IContainerDefinition>Containers?optionalIContainerDefinition[]Containers?optional*[]IContainerDefinition = None #credentials?optionalCredentialscredentials?optionalCredentialscredentials?optionalCredentialsCredentials?optionalCredentialsCredentials?optionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
enableNetworkIsolation?optionalbooleanenable_network_isolation?optionalboolenableNetworkIsolation?optionalBooleanEnableNetworkIsolation?optionalboolEnableNetworkIsolation?optional*bool = false #No inbound or outbound network calls can be made to or from the model container.
heartbeat?optionalDurationheartbeat?optionalDurationheartbeat?optionalDurationHeartbeat?optionalDurationHeartbeat?optionalDuration = None deprecated #heartbeatTimeout?optionalTimeoutheartbeat_timeout?optionalTimeoutheartbeatTimeout?optionalTimeoutHeartbeatTimeout?optionalTimeoutHeartbeatTimeout?optionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPath?optionalstringinput_path?optionalstrinputPath?optionalStringInputPath?optionalstringInputPath?optional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPattern?optionalIntegrationPatternintegration_pattern?optionalIntegrationPatternintegrationPattern?optionalIntegrationPatternIntegrationPattern?optionalIntegrationPatternIntegrationPattern?optionalIntegrationPattern #Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
outputPath?optionalstringoutput_path?optionalstroutputPath?optionalStringOutputPath?optionalstringOutputPath?optional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
primaryContainerIContainerDefinitionprimary_containerIContainerDefinitionprimaryContainerIContainerDefinitionPrimaryContainerIContainerDefinitionPrimaryContainerIContainerDefinition required #queryLanguage?optionalQueryLanguagequery_language?optionalQueryLanguagequeryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultPath?optionalstringresult_path?optionalstrresultPath?optionalStringResultPath?optionalstringResultPath?optional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector?optional{ [key: string]: any }result_selector?optionaltyping.Mapping[str, Any]resultSelector?optionalMap<String, Object>ResultSelector?optionalIDictionary<string, object>ResultSelector?optional*map[string]interface{} = None #You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: a role will be created.
stateName?optionalstringstate_name?optionalstrstateName?optionalStringStateName?optionalstringStateName?optional*string #Default: The construct ID will be used as state name
subnetSelection?optionalSubnetSelectionsubnet_selection?optionalSubnetSelectionsubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelection #Default: Private Subnets are selected
tags?optionalTaskInputtags?optionalTaskInputtags?optionalTaskInputTags?optionalTaskInputTags?optionalTaskInput #Default: No tags
taskTimeout?optionalTimeouttask_timeout?optionalTimeouttaskTimeout?optionalTimeoutTaskTimeout?optionalTimeoutTaskTimeout?optionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface