Skip to content
v2.274.0

CfnCustomActionTypeProps Struct ​

Properties for defining a CfnCustomActionType.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const cfnCustomActionTypeProps: codepipeline.CfnCustomActionTypeProps = {
  category: 'category',
  inputArtifactDetails: {
    maximumCount: 123,
    minimumCount: 123,
  },
  outputArtifactDetails: {
    maximumCount: 123,
    minimumCount: 123,
  },
  provider: 'provider',
  version: 'version',

  // the properties below are optional
  configurationProperties: [{
    key: false,
    name: 'name',
    required: false,
    secret: false,

    // the properties below are optional
    description: 'description',
    queryable: false,
    type: 'type',
  }],
  settings: {
    entityUrlTemplate: 'entityUrlTemplate',
    executionUrlTemplate: 'executionUrlTemplate',
    revisionUrlTemplate: 'revisionUrlTemplate',
    thirdPartyConfigurationUrl: 'thirdPartyConfigurationUrl',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

categorystringcategorystrcategoryStringCategorystringCategory*stringrequired#
The category of the custom action, such as a build action or a test action.
configurationPropertiesoptionalIResolvable | IResolvable | CfnCustomActionType.ConfigurationPropertiesProperty[]configuration_propertiesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConfigurationPropertiesProperty]]]configurationPropertiesoptionalIResolvableConfigurationPropertiesoptionalIResolvableConfigurationPropertiesoptionalinterface{}#
The configuration properties for the custom action.
notes

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

inputArtifactDetailsIResolvable | CfnCustomActionType.ArtifactDetailsPropertyinput_artifact_detailstyping.Union[IResolvable, ArtifactDetailsProperty]inputArtifactDetailsIResolvableInputArtifactDetailsIResolvableInputArtifactDetailsinterface{}required#
The details of the input artifact for the action, such as its commit ID.
outputArtifactDetailsIResolvable | CfnCustomActionType.ArtifactDetailsPropertyoutput_artifact_detailstyping.Union[IResolvable, ArtifactDetailsProperty]outputArtifactDetailsIResolvableOutputArtifactDetailsIResolvableOutputArtifactDetailsinterface{}required#
The details of the output artifact of the action, such as its commit ID.
providerstringproviderstrproviderStringProviderstringProvider*stringrequired#
The provider of the service used in the custom action, such as CodeDeploy.
settingsoptionalIResolvable | CfnCustomActionType.SettingsPropertysettingsoptionaltyping.Union[IResolvable, SettingsProperty]settingsoptionalIResolvableSettingsoptionalIResolvableSettingsoptionalinterface{}#
URLs that provide users information about this custom action.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags for the custom action.
versionstringversionstrversionStringVersionstringVersion*stringrequired#
The version identifier of the custom action.