Skip to content
v2.275.0

CfnActionProps Struct ​

Properties for defining a CfnAction.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnActionProps: sagemaker.CfnActionProps = {
  actionName: 'actionName',
  actionType: 'actionType',
  source: {
    sourceUri: 'sourceUri',

    // the properties below are optional
    sourceId: 'sourceId',
    sourceType: 'sourceType',
  },

  // the properties below are optional
  description: 'description',
  metadataProperties: {
    commitId: 'commitId',
    generatedBy: 'generatedBy',
    projectId: 'projectId',
    repository: 'repository',
  },
  properties: {
    propertiesKey: 'properties',
  },
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
The name of the action.

Must be unique to your account in an AWS Region.

actionTypestringaction_typestractionTypeStringActionTypestringActionType*stringrequired#
The action type.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the action.
metadataPropertiesoptionalIResolvable | CfnAction.MetadataPropertiesPropertymetadata_propertiesoptionaltyping.Union[IResolvable, MetadataPropertiesProperty]metadataPropertiesoptionalIResolvableMetadataPropertiesoptionalIResolvableMetadataPropertiesoptionalinterface{}#
propertiesoptionalIResolvable | { [key: string]: string }propertiesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]propertiesoptionalIResolvablePropertiesoptionalIResolvablePropertiesoptionalinterface{}#
A list of properties to add to the action.
sourceIResolvable | CfnAction.ActionSourcePropertysourcetyping.Union[IResolvable, ActionSourceProperty]sourceIResolvableSourceIResolvableSourceinterface{}required#
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
The status of the action.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to apply to the action.