1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codepipeline
  5. CustomActionType

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.codepipeline.CustomActionType

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

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.

Create CustomActionType Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CustomActionType(name: string, args: CustomActionTypeArgs, opts?: CustomResourceOptions);
@overload
def CustomActionType(resource_name: str,
                     args: CustomActionTypeArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def CustomActionType(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     category: Optional[str] = None,
                     input_artifact_details: Optional[CustomActionTypeArtifactDetailsArgs] = None,
                     output_artifact_details: Optional[CustomActionTypeArtifactDetailsArgs] = None,
                     provider: Optional[str] = None,
                     version: Optional[str] = None,
                     configuration_properties: Optional[Sequence[CustomActionTypeConfigurationPropertiesArgs]] = None,
                     settings: Optional[CustomActionTypeSettingsArgs] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewCustomActionType(ctx *Context, name string, args CustomActionTypeArgs, opts ...ResourceOption) (*CustomActionType, error)
public CustomActionType(string name, CustomActionTypeArgs args, CustomResourceOptions? opts = null)
public CustomActionType(String name, CustomActionTypeArgs args)
public CustomActionType(String name, CustomActionTypeArgs args, CustomResourceOptions options)
type: aws-native:codepipeline:CustomActionType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomActionTypeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomActionTypeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomActionTypeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomActionTypeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomActionTypeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CustomActionType Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CustomActionType resource accepts the following input properties:

Category This property is required. string
The category of the custom action, such as a build action or a test action.
InputArtifactDetails This property is required. Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeArtifactDetails
The details of the input artifact for the action, such as its commit ID.
OutputArtifactDetails This property is required. Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeArtifactDetails
The details of the output artifact of the action, such as its commit ID.
Provider This property is required. string
The provider of the service used in the custom action, such as AWS CodeDeploy.
Version This property is required. string
The version identifier of the custom action.
ConfigurationProperties List<Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeConfigurationProperties>
The configuration properties for the custom action.
Settings Pulumi.AwsNative.CodePipeline.Inputs.CustomActionTypeSettings
URLs that provide users information about this custom action.
Tags List<Pulumi.AwsNative.Inputs.Tag>
Any tags assigned to the custom action.
Category This property is required. string
The category of the custom action, such as a build action or a test action.
InputArtifactDetails This property is required. CustomActionTypeArtifactDetailsArgs
The details of the input artifact for the action, such as its commit ID.
OutputArtifactDetails This property is required. CustomActionTypeArtifactDetailsArgs
The details of the output artifact of the action, such as its commit ID.
Provider This property is required. string
The provider of the service used in the custom action, such as AWS CodeDeploy.
Version This property is required. string
The version identifier of the custom action.
ConfigurationProperties []CustomActionTypeConfigurationPropertiesArgs
The configuration properties for the custom action.
Settings CustomActionTypeSettingsArgs
URLs that provide users information about this custom action.
Tags TagArgs
Any tags assigned to the custom action.
category This property is required. String
The category of the custom action, such as a build action or a test action.
inputArtifactDetails This property is required. CustomActionTypeArtifactDetails
The details of the input artifact for the action, such as its commit ID.
outputArtifactDetails This property is required. CustomActionTypeArtifactDetails
The details of the output artifact of the action, such as its commit ID.
provider This property is required. String
The provider of the service used in the custom action, such as AWS CodeDeploy.
version This property is required. String
The version identifier of the custom action.
configurationProperties List<CustomActionTypeConfigurationProperties>
The configuration properties for the custom action.
settings CustomActionTypeSettings
URLs that provide users information about this custom action.
tags List<Tag>
Any tags assigned to the custom action.
category This property is required. string
The category of the custom action, such as a build action or a test action.
inputArtifactDetails This property is required. CustomActionTypeArtifactDetails
The details of the input artifact for the action, such as its commit ID.
outputArtifactDetails This property is required. CustomActionTypeArtifactDetails
The details of the output artifact of the action, such as its commit ID.
provider This property is required. string
The provider of the service used in the custom action, such as AWS CodeDeploy.
version This property is required. string
The version identifier of the custom action.
configurationProperties CustomActionTypeConfigurationProperties[]
The configuration properties for the custom action.
settings CustomActionTypeSettings
URLs that provide users information about this custom action.
tags Tag[]
Any tags assigned to the custom action.
category This property is required. str
The category of the custom action, such as a build action or a test action.
input_artifact_details This property is required. CustomActionTypeArtifactDetailsArgs
The details of the input artifact for the action, such as its commit ID.
output_artifact_details This property is required. CustomActionTypeArtifactDetailsArgs
The details of the output artifact of the action, such as its commit ID.
provider This property is required. str
The provider of the service used in the custom action, such as AWS CodeDeploy.
version This property is required. str
The version identifier of the custom action.
configuration_properties Sequence[CustomActionTypeConfigurationPropertiesArgs]
The configuration properties for the custom action.
settings CustomActionTypeSettingsArgs
URLs that provide users information about this custom action.
tags Sequence[TagArgs]
Any tags assigned to the custom action.
category This property is required. String
The category of the custom action, such as a build action or a test action.
inputArtifactDetails This property is required. Property Map
The details of the input artifact for the action, such as its commit ID.
outputArtifactDetails This property is required. Property Map
The details of the output artifact of the action, such as its commit ID.
provider This property is required. String
The provider of the service used in the custom action, such as AWS CodeDeploy.
version This property is required. String
The version identifier of the custom action.
configurationProperties List<Property Map>
The configuration properties for the custom action.
settings Property Map
URLs that provide users information about this custom action.
tags List<Property Map>
Any tags assigned to the custom action.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomActionType resource produces the following output properties:

AwsId string
Id string
The provider-assigned unique ID for this managed resource.
AwsId string
Id string
The provider-assigned unique ID for this managed resource.
awsId String
id String
The provider-assigned unique ID for this managed resource.
awsId string
id string
The provider-assigned unique ID for this managed resource.
aws_id str
id str
The provider-assigned unique ID for this managed resource.
awsId String
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

CustomActionTypeArtifactDetails
, CustomActionTypeArtifactDetailsArgs

MaximumCount This property is required. int
The maximum number of artifacts allowed for the action type.
MinimumCount This property is required. int
The minimum number of artifacts allowed for the action type.
MaximumCount This property is required. int
The maximum number of artifacts allowed for the action type.
MinimumCount This property is required. int
The minimum number of artifacts allowed for the action type.
maximumCount This property is required. Integer
The maximum number of artifacts allowed for the action type.
minimumCount This property is required. Integer
The minimum number of artifacts allowed for the action type.
maximumCount This property is required. number
The maximum number of artifacts allowed for the action type.
minimumCount This property is required. number
The minimum number of artifacts allowed for the action type.
maximum_count This property is required. int
The maximum number of artifacts allowed for the action type.
minimum_count This property is required. int
The minimum number of artifacts allowed for the action type.
maximumCount This property is required. Number
The maximum number of artifacts allowed for the action type.
minimumCount This property is required. Number
The minimum number of artifacts allowed for the action type.

CustomActionTypeConfigurationProperties
, CustomActionTypeConfigurationPropertiesArgs

Key This property is required. bool
Whether the configuration property is a key.
Name This property is required. string
The name of the action configuration property.
Required This property is required. bool
Whether the configuration property is a required value.
Secret This property is required. bool
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
Description string
The description of the action configuration property that is displayed to users.
Queryable bool
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
The type of the configuration property.
Key This property is required. bool
Whether the configuration property is a key.
Name This property is required. string
The name of the action configuration property.
Required This property is required. bool
Whether the configuration property is a required value.
Secret This property is required. bool
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
Description string
The description of the action configuration property that is displayed to users.
Queryable bool
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
The type of the configuration property.
key This property is required. Boolean
Whether the configuration property is a key.
name This property is required. String
The name of the action configuration property.
required This property is required. Boolean
Whether the configuration property is a required value.
secret This property is required. Boolean
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
description String
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
The type of the configuration property.
key This property is required. boolean
Whether the configuration property is a key.
name This property is required. string
The name of the action configuration property.
required This property is required. boolean
Whether the configuration property is a required value.
secret This property is required. boolean
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
description string
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
The type of the configuration property.
key This property is required. bool
Whether the configuration property is a key.
name This property is required. str
The name of the action configuration property.
required This property is required. bool
Whether the configuration property is a required value.
secret This property is required. bool
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
description str
The description of the action configuration property that is displayed to users.
queryable bool
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 str
The type of the configuration property.
key This property is required. Boolean
Whether the configuration property is a key.
name This property is required. String
The name of the action configuration property.
required This property is required. Boolean
Whether the configuration property is a required value.
secret This property is required. Boolean
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
description String
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
The type of the configuration property.

CustomActionTypeSettings
, CustomActionTypeSettingsArgs

EntityUrlTemplate string
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
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
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
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.
EntityUrlTemplate string
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
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
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
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.
entityUrlTemplate String
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
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
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
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.
entityUrlTemplate string
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
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
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
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.
entity_url_template str
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.
execution_url_template str
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.
revision_url_template str
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.
third_party_configuration_url str
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.
entityUrlTemplate String
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
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
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
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
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi