AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS CodePipeline CreateCustomActionType API operation.

Syntax

New-CPCustomActionType
-Category <ActionCategory>
-ConfigurationProperty <ActionConfigurationProperty[]>
-Settings_EntityUrlTemplate <String>
-Settings_ExecutionUrlTemplate <String>
-InputArtifactDetails_MaximumCount <Int32>
-OutputArtifactDetails_MaximumCount <Int32>
-InputArtifactDetails_MinimumCount <Int32>
-OutputArtifactDetails_MinimumCount <Int32>
-Provider <String>
-Settings_RevisionUrlTemplate <String>
-Tag <Tag[]>
-Settings_ThirdPartyConfigurationUrl <String>
-Version <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCodePipelineConfig>

Description

Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.

Parameters

-Category <ActionCategory>
The category of the custom action, such as a build action or a test action.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonCodePipelineConfig>
Amazon.PowerShell.Cmdlets.CP.AmazonCodePipelineClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationProperty <ActionConfigurationProperty[]>
The configuration properties for the custom action.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationProperties
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputArtifactDetails_MaximumCount <Int32>
The maximum number of artifacts allowed for the action type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputArtifactDetails_MinimumCount <Int32>
The minimum number of artifacts allowed for the action type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputArtifactDetails_MaximumCount <Int32>
The maximum number of artifacts allowed for the action type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputArtifactDetails_MinimumCount <Int32>
The minimum number of artifacts allowed for the action type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Provider <String>
The provider of the service used in the custom action, such as CodeDeploy.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ActionType'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodePipeline.Model.CreateCustomActionTypeResponse). Specifying the name of a property of type Amazon.CodePipeline.Model.CreateCustomActionTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_EntityUrlTemplate <String>
The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_ExecutionUrlTemplate <String>
The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_RevisionUrlTemplate <String>
The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags for the custom action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Version <String>
The version identifier of the custom action.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CodePipeline.Model.ActionType or Amazon.CodePipeline.Model.CreateCustomActionTypeResponse
This cmdlet returns an Amazon.CodePipeline.Model.ActionType object. The service call response (type Amazon.CodePipeline.Model.CreateCustomActionTypeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

New-CPCustomActionType -Category Build -ConfigurationProperty @{"Description" = "The name of the build project must be provided when this action is added to the pipeline."; "Key" = $True; "Name" = "ProjectName"; "Queryable" = $False; "Required" = $True; "Secret" = $False; "Type" = "String"} -Settings_EntityUrlTemplate "https://my-build-instance/job/{Config:ProjectName}/" -Settings_ExecutionUrlTemplate "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild{ExternalExecutionId}/" -InputArtifactDetails_MaximumCount 1 -OutputArtifactDetails_MaximumCount 1 -InputArtifactDetails_MinimumCount 0 -OutputArtifactDetails_MinimumCount 0 -Provider "MyBuildProviderName" -Version 1

ActionConfigurationProperties : {ProjectName}
Id                            : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails          : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails         : Amazon.CodePipeline.Model.ArtifactDetails
Settings                      : Amazon.CodePipeline.Model.ActionTypeSettings
This example creates a new custom action with the specified properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z