Package software.amazon.awscdk.services.sagemaker

Interface CfnActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:11.162Z")
@Stability(Stable)
public interface CfnActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAction.

Example:

 // 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.*;
 CfnActionProps cfnActionProps = CfnActionProps.builder()
         .actionName("actionName")
         .actionType("actionType")
         .source(ActionSourceProperty.builder()
                 .sourceUri("sourceUri")
                 // the properties below are optional
                 .sourceId("sourceId")
                 .sourceType("sourceType")
                 .build())
         // the properties below are optional
         .description("description")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .properties(Map.of(
                 "propertiesKey", "properties"))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnActionProps.Builder	A builder for CfnActionProps
static final class	CfnActionProps.Jsii$Proxy	An implementation for CfnActionProps

Method Summary

Modifier and Type	Method	Description
static CfnActionProps.Builder	builder()
String	getActionName()	The name of the action.
String	getActionType()	The action type.
default String	getDescription()	The description of the action.
default Object	getMetadataProperties()	Returns union: either IResolvable or CfnAction.MetadataPropertiesProperty
default Object	getProperties()	A list of properties to add to the action.
Object	getSource()	Returns union: either IResolvable or CfnAction.ActionSourceProperty
default String	getStatus()	The status of the action.
default List<CfnTag>	getTags()	A list of tags to apply to the action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

@Stability(Stable)
@NotNull
String getActionName()

The name of the action.

Must be unique to your account in an AWS Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-actionname

getActionType

@Stability(Stable)
@NotNull
String getActionType()

The action type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-actiontype

getSource

@Stability(Stable)
@NotNull
Object getSource()

Returns union: either IResolvable or CfnAction.ActionSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-source

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-description

getMetadataProperties

@Stability(Stable)
@Nullable
default Object getMetadataProperties()

Returns union: either IResolvable or CfnAction.MetadataPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-metadataproperties

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

A list of properties to add to the action.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-properties

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags to apply to the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-action.html#cfn-sagemaker-action-tags

builder

@Stability(Stable)
static CfnActionProps.Builder builder()

Returns:

a CfnActionProps.Builder of CfnActionProps