CustomActionRegistration
The resource representing registering a custom Action with CodePipeline.
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.
Example
ts
// Make a custom CodePipeline Action
new codepipeline.CustomActionRegistration(this, 'GenericGitSourceProviderResource', {
category: codepipeline.ActionCategory.SOURCE,
artifactBounds: { 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: [
{
name: 'Branch',
required: true,
key: false,
secret: false,
queryable: false,
description: 'Git branch to pull',
type: 'String',
},
{
name: 'GitUrl',
required: true,
key: false,
secret: false,
queryable: false,
description: 'SSH git clone URL',
type: 'String',
},
],
});
python
# Make a custom CodePipeline Action
codepipeline.CustomActionRegistration(self, "GenericGitSourceProviderResource",
category=codepipeline.ActionCategory.SOURCE,
artifact_bounds=codepipeline.ActionArtifactBounds(min_inputs=0, max_inputs=0, min_outputs=1, max_outputs=1),
provider="GenericGitSource",
version="1",
entity_url="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
execution_url="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
action_properties=[codepipeline.CustomActionProperty(
name="Branch",
required=True,
key=False,
secret=False,
queryable=False,
description="Git branch to pull",
type="String"
), codepipeline.CustomActionProperty(
name="GitUrl",
required=True,
key=False,
secret=False,
queryable=False,
description="SSH git clone URL",
type="String"
)
]
)
java
// Make a custom CodePipeline Action
// Make a custom CodePipeline Action
CustomActionRegistration.Builder.create(this, "GenericGitSourceProviderResource")
.category(ActionCategory.SOURCE)
.artifactBounds(ActionArtifactBounds.builder().minInputs(0).maxInputs(0).minOutputs(1).maxOutputs(1).build())
.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(List.of(CustomActionProperty.builder()
.name("Branch")
.required(true)
.key(false)
.secret(false)
.queryable(false)
.description("Git branch to pull")
.type("String")
.build(), CustomActionProperty.builder()
.name("GitUrl")
.required(true)
.key(false)
.secret(false)
.queryable(false)
.description("SSH git clone URL")
.type("String")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Make a custom CodePipeline Action
// Make a custom CodePipeline Action
codepipeline.NewCustomActionRegistration(this, jsii.String("GenericGitSourceProviderResource"), &CustomActionRegistrationProps{
Category: codepipeline.ActionCategory_SOURCE,
ArtifactBounds: &ActionArtifactBounds{
MinInputs: jsii.Number(0),
MaxInputs: jsii.Number(0),
MinOutputs: jsii.Number(1),
MaxOutputs: jsii.Number(1),
},
Provider: jsii.String("GenericGitSource"),
Version: jsii.String("1"),
EntityUrl: jsii.String("https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html"),
ExecutionUrl: jsii.String("https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html"),
ActionProperties: []CustomActionProperty{
&CustomActionProperty{
Name: jsii.String("Branch"),
Required: jsii.Boolean(true),
Key: jsii.Boolean(false),
Secret: jsii.Boolean(false),
Queryable: jsii.Boolean(false),
Description: jsii.String("Git branch to pull"),
Type: jsii.String("String"),
},
&CustomActionProperty{
Name: jsii.String("GitUrl"),
Required: jsii.Boolean(true),
Key: jsii.Boolean(false),
Secret: jsii.Boolean(false),
Queryable: jsii.Boolean(false),
Description: jsii.String("SSH git clone URL"),
Type: jsii.String("String"),
},
},
})
Initializer
ts
new CustomActionRegistration(scope: Construct, id: string, props: CustomActionRegistrationProps)
python
CustomActionRegistration(scope: Construct, id: str, props: CustomActionRegistrationProps)
java
new CustomActionRegistration(Construct scope, String id, CustomActionRegistrationProps props)
csharp
new CustomActionRegistration(Construct scope, string id, CustomActionRegistrationProps props)
go
NewCustomActionRegistration(Scope Construct, Id *string, Props CustomActionRegistrationProps)
Construct Props
actionPropertiesoptionalCustomActionProperty[]action_propertiesoptionaltyping.List[CustomActionProperty]actionPropertiesoptionalList<CustomActionProperty>ActionPropertiesoptionalCustomActionProperty[]ActionPropertiesoptional*[]CustomActionProperty= []#The properties used for customizing the instance of your Action.
artifactBoundsActionArtifactBoundsartifact_boundsActionArtifactBoundsartifactBoundsActionArtifactBoundsArtifactBoundsActionArtifactBoundsArtifactBoundsActionArtifactBoundsrequired#The artifact bounds of the Action.
categoryActionCategorycategoryActionCategorycategoryActionCategoryCategoryActionCategoryCategoryActionCategoryrequired#The category of the Action.
entityUrloptionalstringentity_urloptionalstrentityUrloptionalStringEntityUrloptionalstringEntityUrloptional*string= none#The URL shown for the entire Action in the Pipeline UI.
executionUrloptionalstringexecution_urloptionalstrexecutionUrloptionalStringExecutionUrloptionalstringExecutionUrloptional*string= none#The URL shown for a particular execution of an Action in the Pipeline UI.
The provider of the Action.
For example, 'MyCustomActionProvider'
versionoptionalstringversionoptionalstrversionoptionalStringVersionoptionalstringVersionoptional*string= '1'#The version of your Action.
Properties
Methods
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining