Interface ICustomActionRegistrationProps

Properties of registering a custom Action.

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICustomActionRegistrationProps

Syntax (vb)

Public Interface 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

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.

Properties

ActionProperties

The properties used for customizing the instance of your Action.

ICustomActionProperty[]? ActionProperties { get; }

Property Value

ICustomActionProperty[]

Remarks

Default: []

ArtifactBounds

The artifact bounds of the Action.

IActionArtifactBounds ArtifactBounds { get; }

Property Value

IActionArtifactBounds

Remarks

ExampleMetadata: infused

EntityUrl

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

string? EntityUrl { get; }

Property Value

string

Remarks

Default: none

ExecutionUrl

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

string? ExecutionUrl { get; }

Property Value

string

Remarks

Default: none

Provider

The provider of the Action.

string Provider { get; }

Property Value

string

Remarks

For example, 'MyCustomActionProvider'

Version

The version of your Action.

string? Version { get; }

Property Value

string

Remarks

Default: '1'