# 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.

Extends: Construct › CustomActionRegistration
Implements: IConstruct, IDependable

- Source: [`aws-codepipeline/lib/custom-action-registration.ts`](https://github.com/aws/aws-cdk/blob/v2.276.0/packages/aws-cdk-lib/aws-codepipeline/lib/custom-action-registration.ts#L116)

## 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',
    },
  ],
});
```

## Initializer

```ts
new CustomActionRegistration(scope: Construct, id: string, props: CustomActionRegistrationProps)
```

## Construct Props

- `actionProperties`: [CustomActionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.CustomActionProperty.html)[] = [] — The properties used for customizing the instance of your Action.

- `artifactBounds`: [ActionArtifactBounds](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.ActionArtifactBounds.html) (required) — The artifact bounds of the Action.

- `category`: [ActionCategory](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.ActionCategory.html) (required) — The category of the Action.

- `entityUrl`: string = none — The URL shown for the entire Action in the Pipeline UI.

- `executionUrl`: string = none — The URL shown for a particular execution of an Action in the Pipeline UI.

- `provider`: string (required) — The provider of the Action.

  For example, `'MyCustomActionProvider'`

- `version`: string = '1' — The version of your Action.

## Properties

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

## Methods

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  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**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `toString(): string` — Returns a string representation of this construct.

- `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.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining