Show / Hide Table of Contents

Class CustomActionRegistration

The resource representing registering a custom Action with CodePipeline.

Inheritance
System.Object
Construct
CustomActionRegistration
Implements
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public class CustomActionRegistration : Construct, IConstruct, IDependable
Syntax (vb)
Public Class CustomActionRegistration
    Inherits Construct
    Implements IConstruct, IDependable
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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CustomActionRegistration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

CustomActionRegistration(Construct, String, ICustomActionRegistrationProps)

Constructors

CustomActionRegistration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CustomActionRegistration(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CustomActionRegistration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CustomActionRegistration(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CustomActionRegistration(Construct, String, ICustomActionRegistrationProps)

public CustomActionRegistration(Construct scope, string id, ICustomActionRegistrationProps props)
Parameters
scope Constructs.Construct
id System.String
props ICustomActionRegistrationProps

Implements

IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX