interface ActionProperties

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.ActionProperties
Java	software.amazon.awscdk.services.codepipeline.ActionProperties
Python	aws_cdk.aws_codepipeline.ActionProperties
TypeScript (source)	@aws-cdk/aws-codepipeline » ActionProperties

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as iam from '@aws-cdk/aws-iam';
import * as cdk from '@aws-cdk/core';

declare const artifact: codepipeline.Artifact;
declare const resource: cdk.Resource;
declare const role: iam.Role;
const actionProperties: codepipeline.ActionProperties = {
  actionName: 'actionName',
  artifactBounds: {
    maxInputs: 123,
    maxOutputs: 123,
    minInputs: 123,
    minOutputs: 123,
  },
  category: codepipeline.ActionCategory.SOURCE,
  provider: 'provider',

  // the properties below are optional
  account: 'account',
  inputs: [artifact],
  outputs: [artifact],
  owner: 'owner',
  region: 'region',
  resource: resource,
  role: role,
  runOrder: 123,
  variablesNamespace: 'variablesNamespace',
  version: 'version',
};

Properties

Name	Type	Description
actionName	string
artifactBounds	ActionArtifactBounds
category	ActionCategory	The category of the action.
provider	string	The service provider that the action calls.
account?	string	The account the Action is supposed to live in.
inputs?	Artifact[]
outputs?	Artifact[]
owner?	string
region?	string	The AWS region the given Action resides in.
resource?	IResource	The optional resource that is backing this Action.
role?	IRole
runOrder?	number	The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.
variablesNamespace?	string	The name of the namespace to use for variables emitted by this action.
version?	string

---

actionName

Type: string

---

artifactBounds

Type: ActionArtifactBounds

---

category

Type: ActionCategory

The category of the action.

The category defines which action type the owner (the entity that performs the action) performs.

---

provider

Type: string

The service provider that the action calls.

---

account?

Type: string (optional)

The account the Action is supposed to live in.

For Actions backed by resources, this is inferred from the Stack {@link resource} is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify either {@link resource}, or {@link account} - but not both.

---

inputs?

Type: Artifact[] (optional)

---

outputs?

Type: Artifact[] (optional)

---

owner?

Type: string (optional)

---

region?

Type: string (optional, default: the Action resides in the same region as the Pipeline)

The AWS region the given Action resides in.

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

---

resource?

Type: IResource (optional)

The optional resource that is backing this Action.

This is used for automatically handling Actions backed by resources from a different account and/or region.

---

role?

Type: IRole (optional)

---

runOrder?

Type: number (optional)

The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

---

variablesNamespace?

Type: string (optional, default: a name will be generated, based on the stage and action names)

The name of the namespace to use for variables emitted by this action.

---

version?

Type: string (optional)