Class CustomActionRegistrationProps

Properties of registering a custom Action.

Inheritance

System.Object

CustomActionRegistrationProps

Implements

ICustomActionRegistrationProps

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CustomActionRegistrationProps : Object, ICustomActionRegistrationProps

Syntax (vb)

Public Class CustomActionRegistrationProps
    Inherits Object
    Implements ICustomActionRegistrationProps

Remarks

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

CustomActionRegistrationProps()

Properties

ActionProperties	The properties used for customizing the instance of your Action.
ArtifactBounds	The artifact bounds of the Action.
Category	The category of the Action.
EntityUrl	The URL shown for the entire Action in the Pipeline UI.
ExecutionUrl	The URL shown for a particular execution of an Action in the Pipeline UI.
Provider	The provider of the Action.
Version	The version of your Action.

Constructors

CustomActionRegistrationProps()

public CustomActionRegistrationProps()

Properties

ActionProperties

The properties used for customizing the instance of your Action.

public ICustomActionProperty[] ActionProperties { get; set; }

Property Value

ICustomActionProperty[]

Remarks

Default: []

ArtifactBounds

The artifact bounds of the Action.

public IActionArtifactBounds ArtifactBounds { get; set; }

Property Value

IActionArtifactBounds

EntityUrl

The URL shown for the entire Action in the Pipeline UI.

public string EntityUrl { get; set; }

Property Value

System.String

Remarks

Default: none

ExecutionUrl

The URL shown for a particular execution of an Action in the Pipeline UI.

public string ExecutionUrl { get; set; }

Property Value

System.String

Remarks

Default: none

Provider

The provider of the Action.

public string Provider { get; set; }

Property Value

System.String

Remarks

For example, 'MyCustomActionProvider'

Version

The version of your Action.

public string Version { get; set; }

Property Value

System.String

Remarks

Default: '1'

Implements

ICustomActionRegistrationProps