SageMakerCreateModelProps
- class aws_cdk.aws_stepfunctions_tasks.SageMakerCreateModelProps(*, comment=None, query_language=None, state_name=None, credentials=None, heartbeat=None, heartbeat_timeout=None, integration_pattern=None, task_timeout=None, timeout=None, assign=None, input_path=None, output_path=None, outputs=None, result_path=None, result_selector=None, model_name, primary_container, containers=None, enable_network_isolation=None, role=None, subnet_selection=None, tags=None, vpc=None)
Bases:
TaskStateBaseProps
Properties for creating an Amazon SageMaker model.
- Parameters:
comment (
Optional
[str
]) – A comment describing this state. Default: No commentquery_language (
Optional
[QueryLanguage
]) – The name of the query language used by the state. If the state does not contain aqueryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field. Default: - JSONPathstate_name (
Optional
[str
]) – Optional name for this state. Default: - The construct ID will be used as state namecredentials (
Union
[Credentials
,Dict
[str
,Any
],None
]) – Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations. Default: - None (Task is executed using the State Machine’s execution role)heartbeat (
Optional
[Duration
]) – (deprecated) Timeout for the heartbeat. Default: - Noneheartbeat_timeout (
Optional
[Timeout
]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - Noneintegration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns. Depending on the AWS Service, the Service Integration Pattern availability will vary. Default: -IntegrationPattern.REQUEST_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.task_timeout (
Optional
[Timeout
]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - Nonetimeout (
Optional
[Duration
]) – (deprecated) Timeout for the task. Default: - Noneassign (
Optional
[Mapping
[str
,Any
]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variablesinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: $output_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: $outputs (
Any
) – Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly. Default: - $states.result or $states.errorOutputresult_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: $result_selector (
Optional
[Mapping
[str
,Any
]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - Nonemodel_name (
str
) – The name of the new model.primary_container (
IContainerDefinition
) – The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.containers (
Optional
[Sequence
[IContainerDefinition
]]) – Specifies the containers in the inference pipeline. Default: - Noneenable_network_isolation (
Optional
[bool
]) – Isolates the model container. No inbound or outbound network calls can be made to or from the model container. Default: falserole (
Optional
[IRole
]) – An execution role that you can pass in a CreateModel API request. Default: - a role will be created.subnet_selection (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided). Default: - Private Subnets are selectedtags (
Optional
[TaskInput
]) – Tags to be applied to the model. Default: - No tagsvpc (
Optional
[IVpc
]) – The VPC that is accessible by the hosted model. Default: - None
- See:
https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html
- ExampleMetadata:
infused
Example:
tasks.SageMakerCreateModel(self, "Sagemaker", model_name="MyModel", primary_container=tasks.ContainerDefinition( image=tasks.DockerImage.from_json_expression(sfn.JsonPath.string_at("$.Model.imageName")), mode=tasks.Mode.SINGLE_MODEL, model_s3_location=tasks.S3Location.from_json_expression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts") ) )
Attributes
- assign
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
- Default:
Not assign variables
- See:
https://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/workflow-variables.html
- comment
A comment describing this state.
- Default:
No comment
- containers
Specifies the containers in the inference pipeline.
- Default:
None
- credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
- Default:
None (Task is executed using the State Machine’s execution role)
- See:
https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
- enable_network_isolation
Isolates the model container.
No inbound or outbound network calls can be made to or from the model container.
- Default:
false
- heartbeat
(deprecated) Timeout for the heartbeat.
- Default:
None
- Deprecated:
use
heartbeatTimeout
- Stability:
deprecated
- heartbeat_timeout
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- Default:
None
- input_path
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
- Default:
$
- integration_pattern
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
- Default:
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
- model_name
The name of the new model.
- output_path
JSONPath expression to select part of the state to be the output to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default:
$
- outputs
Used to specify and transform output from the state.
When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
- Default:
$states.result or $states.errorOutput
- See:
https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html
- primary_container
The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
- query_language
The name of the query language used by the state.
If the state does not contain a
queryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field.- Default:
JSONPath
- result_path
JSONPath expression to indicate where to inject the state’s output.
May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.
- Default:
$
- result_selector
The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.
- role
An execution role that you can pass in a CreateModel API request.
- Default:
a role will be created.
- state_name
Optional name for this state.
- Default:
The construct ID will be used as state name
- subnet_selection
The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).
- Default:
Private Subnets are selected
- tags
Tags to be applied to the model.
- Default:
No tags
- task_timeout
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- Default:
None
- timeout
(deprecated) Timeout for the task.
- Default:
None
- Deprecated:
use
taskTimeout
- Stability:
deprecated
- vpc
The VPC that is accessible by the hosted model.
- Default:
None