SageMakerCreateEndpointConfigProps

class aws_cdk.aws_stepfunctions_tasks.SageMakerCreateEndpointConfigProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, endpoint_config_name, production_variants, kms_key=None, tags=None)

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

Properties for creating an Amazon SageMaker endpoint configuration.

Parameters

  • comment (Optional[str]) – An optional description for this state. Default: - No comment

  • heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None

  • input_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_RESPONSE

  • output_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 ‘$’)

  • 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: - None

  • timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

  • endpoint_config_name (str) – The name of the endpoint configuration.

  • production_variants (Sequence[ProductionVariant]) – An list of ProductionVariant objects, one for each model that you want to host at this endpoint. Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

  • kms_key (Optional[IKey]) – AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. Default: - None

  • tags (Optional[TaskInput]) – Tags to be applied to the endpoint configuration. Default: - No tags

See

https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html

Example:

tasks.SageMakerCreateEndpointConfig(self, "SagemakerEndpointConfig",
    endpoint_config_name="MyEndpointConfig",
    production_variants=[tasks.ProductionVariant(
        initial_instance_count=2,
        instance_type=ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.XLARGE),
        model_name="MyModel",
        variant_name="awesome-variant"
    )]
)

Attributes

comment

An optional description for this state.

Default

  • No comment

Return type

Optional[str]

endpoint_config_name

The name of the endpoint configuration.

Return type

str

heartbeat

Timeout for the heartbeat.

Default

  • None

Return type

Optional[Duration]

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]

kms_key

AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

Default

  • None

Return type

Optional[IKey]

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]

production_variants

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

Return type

List[ProductionVariant]

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]

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.

Default

  • None

See

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

Return type

Optional[Mapping[str, Any]]

tags

Tags to be applied to the endpoint configuration.

Default

  • No tags

Return type

Optional[TaskInput]

timeout

Timeout for the state machine.

Default

  • None

Return type

Optional[Duration]