Class CustomActionRegistration

The resource representing registering a custom Action with CodePipeline.

Inheritance

object

CustomActionRegistration

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CustomActionRegistration : Construct

Syntax (vb)

Public Class CustomActionRegistration Inherits Construct

Remarks

For the Action to be usable, it has to be registered for every region and every account it's used in. In addition to this class, you should most likely also provide your clients a class representing your custom Action, extending the Action class, and taking the actionProperties as properly typed, construction properties.

ExampleMetadata: infused

Examples

// Make a custom CodePipeline Action
             // Make a custom CodePipeline Action
             new CustomActionRegistration(this, "GenericGitSourceProviderResource", new CustomActionRegistrationProps {
                 Category = ActionCategory.SOURCE,
                 ArtifactBounds = new ActionArtifactBounds { MinInputs = 0, MaxInputs = 0, MinOutputs = 1, MaxOutputs = 1 },
                 Provider = "GenericGitSource",
                 Version = "1",
                 EntityUrl = "https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
                 ExecutionUrl = "https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
                 ActionProperties = new [] { new CustomActionProperty {
                     Name = "Branch",
                     Required = true,
                     Key = false,
                     Secret = false,
                     Queryable = false,
                     Description = "Git branch to pull",
                     Type = "String"
                 }, new CustomActionProperty {
                     Name = "GitUrl",
                     Required = true,
                     Key = false,
                     Secret = false,
                     Queryable = false,
                     Description = "SSH git clone URL",
                     Type = "String"
                 } }
             });

Synopsis

Constructors

CustomActionRegistration(Construct, string, ICustomActionRegistrationProps)

The resource representing registering a custom Action with CodePipeline.

Constructors

CustomActionRegistration(Construct, string, ICustomActionRegistrationProps)

The resource representing registering a custom Action with CodePipeline.

public CustomActionRegistration(Construct scope, string id, ICustomActionRegistrationProps props)

Parameters

scope Construct

id string

props ICustomActionRegistrationProps

Remarks

For the Action to be usable, it has to be registered for every region and every account it's used in. In addition to this class, you should most likely also provide your clients a class representing your custom Action, extending the Action class, and taking the actionProperties as properly typed, construction properties.

ExampleMetadata: infused

Examples

// Make a custom CodePipeline Action
             // Make a custom CodePipeline Action
             new CustomActionRegistration(this, "GenericGitSourceProviderResource", new CustomActionRegistrationProps {
                 Category = ActionCategory.SOURCE,
                 ArtifactBounds = new ActionArtifactBounds { MinInputs = 0, MaxInputs = 0, MinOutputs = 1, MaxOutputs = 1 },
                 Provider = "GenericGitSource",
                 Version = "1",
                 EntityUrl = "https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
                 ExecutionUrl = "https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
                 ActionProperties = new [] { new CustomActionProperty {
                     Name = "Branch",
                     Required = true,
                     Key = false,
                     Secret = false,
                     Queryable = false,
                     Description = "Git branch to pull",
                     Type = "String"
                 }, new CustomActionProperty {
                     Name = "GitUrl",
                     Required = true,
                     Key = false,
                     Secret = false,
                     Queryable = false,
                     Description = "SSH git clone URL",
                     Type = "String"
                 } }
             });