# CustomActionProperty

The creation attributes used for defining a configuration property of a custom Action.

- 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#L9)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const customActionProperty: codepipeline.CustomActionProperty = {
  name: 'name',
  required: false,

  // the properties below are optional
  description: 'description',
  key: false,
  queryable: false,
  secret: false,
  type: 'type',
};
```

## Properties

- `description`: string — The description of the property.

  **Default:** the description will be empty

- `key`: boolean = false — Whether this property is a key.

- `name`: string (required) — The name of the property.

  You use this name in the `configuration` attribute when defining your custom Action class.

- `queryable`: boolean = false — Whether this property is queryable.

  Note that only a single property of a custom Action can be queryable.

- `required`: boolean (required) — Whether this property is required.

- `secret`: boolean = false — Whether this property is secret, like a password, or access key.

- `type`: string = 'String' — The type of the property, like 'String', 'Number', or 'Boolean'.