Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-codepipeline-customactiontype.json
Parent schema serverless-framework-configuration
Type: object

The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline.git

Properties

Category string | Aws_CF_FunctionString required

The category of the custom action, such as a build action or a test action.

InputArtifactDetails object required

Returns information about the details of an artifact.

2 nested properties
MaximumCount integer required

The maximum number of artifacts allowed for the action type.

MinimumCount integer required

The minimum number of artifacts allowed for the action type.

OutputArtifactDetails object required

Returns information about the details of an artifact.

2 nested properties
MaximumCount integer required

The maximum number of artifacts allowed for the action type.

MinimumCount integer required

The minimum number of artifacts allowed for the action type.

Provider string | Aws_CF_FunctionString required

The provider of the service used in the custom action, such as AWS CodeDeploy.

Version string | Aws_CF_FunctionString required

The version identifier of the custom action.

ConfigurationProperties ConfigurationProperties[]

The configuration properties for the custom action.

uniqueItems=true
Settings object

Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

4 nested properties
EntityUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

ExecutionUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

RevisionUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

ThirdPartyConfigurationUrl string | Aws_CF_FunctionString

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

Tags Tag[]

Any tags assigned to the custom action.

Definitions

ConfigurationProperties object

The configuration properties for the custom action.

Key boolean required

Whether the configuration property is a key.

Name string | Aws_CF_FunctionString required

The name of the action configuration property.

Required boolean required

Whether the configuration property is a required value.

Secret boolean required

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

Description string | Aws_CF_FunctionString

The description of the action configuration property that is displayed to users.

Queryable boolean

Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

Type string | Aws_CF_FunctionString

The type of the configuration property.

ArtifactDetails object

Returns information about the details of an artifact.

MaximumCount integer required

The maximum number of artifacts allowed for the action type.

MinimumCount integer required

The minimum number of artifacts allowed for the action type.

Settings object

Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

EntityUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

ExecutionUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

RevisionUrlTemplate string | Aws_CF_FunctionString

The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

ThirdPartyConfigurationUrl string | Aws_CF_FunctionString

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

Tag object
Value string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required