SageMakerCreateModelProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
SageMakerCreateModelProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, model_name, primary_container, containers=None, enable_network_isolation=None, role=None, subnet_selection=None, tags=None, vpc=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
(experimental) Properties for creating an Amazon SageMaker model.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_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: - The entire task input (JSON path ‘$’)integration_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 Default: IntegrationPattern.REQUEST_RESPONSEoutput_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_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: - Replaces the entire input with the result (JSON path ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonemodel_name (
str
) – (experimental) The name of the new model.primary_container (
IContainerDefinition
) – (experimental) 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
[List
[IContainerDefinition
]]) – (experimental) Specifies the containers in the inference pipeline. Default: - Noneenable_network_isolation (
Optional
[bool
]) – (experimental) Isolates the model container. No inbound or outbound network calls can be made to or from the model container. Default: falserole (
Optional
[IRole
]) – (experimental) An execution role that you can pass in a CreateModel API request. Default: - a role will be created.subnet_selection (
Optional
[SubnetSelection
]) – (experimental) 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
]) – (experimental) Tags to be applied to the model. Default: - No tagsvpc (
Optional
[IVpc
]) – (experimental) The VPC that is accessible by the hosted model. Default: - None
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html
- Stability
experimental
Attributes
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
containers
¶ (experimental) Specifies the containers in the inference pipeline.
- Default
None
- Stability
experimental
- Return type
Optional
[List
[IContainerDefinition
]]
-
enable_network_isolation
¶ (experimental) Isolates the model container.
No inbound or outbound network calls can be made to or from the model container.
- Default
false
- Stability
experimental
- Return type
Optional
[bool
]
-
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
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
model_name
¶ (experimental) The name of the new model.
- Stability
experimental
- Return type
str
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
primary_container
¶ (experimental) 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.
- Stability
experimental
- Return type
-
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
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
role
¶ (experimental) An execution role that you can pass in a CreateModel API request.
- Default
a role will be created.
- Stability
experimental
- Return type
Optional
[IRole
]
-
subnet_selection
¶ (experimental) 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
- Stability
experimental
- Return type
Optional
[SubnetSelection
]
(experimental) Tags to be applied to the model.
- Default
No tags
- Stability
experimental
- Return type
Optional
[TaskInput
]