class CodeDeployEcsDeployAction

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

Implements IAction

Extends Action

Example

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

declare const artifact: codepipeline.Artifact;
declare const artifactPath: codepipeline.ArtifactPath;
declare const ecsDeploymentGroup: codedeploy.IEcsDeploymentGroup;
declare const role: iam.Role;
const codeDeployEcsDeployAction = new codepipeline_actions.CodeDeployEcsDeployAction({
  actionName: 'actionName',
  deploymentGroup: ecsDeploymentGroup,

  // the properties below are optional
  appSpecTemplateFile: artifactPath,
  appSpecTemplateInput: artifact,
  containerImageInputs: [{
    input: artifact,

    // the properties below are optional
    taskDefinitionPlaceholder: 'taskDefinitionPlaceholder',
  }],
  role: role,
  runOrder: 123,
  taskDefinitionTemplateFile: artifactPath,
  taskDefinitionTemplateInput: artifact,
  variablesNamespace: 'variablesNamespace',
});

Initializer

new CodeDeployEcsDeployAction(props: CodeDeployEcsDeployActionProps)

Parameters

• props CodeDeployEcsDeployActionProps

Properties

Name	Type	Description
actionProperties	ActionProperties	The simple properties of the Action, like its Owner, name, etc.

---

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the {@link bind} callback.

Methods

Name	Description
bind(scope, stage, options)	The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)	Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(_scope, _stage, options)	This is a renamed version of the {@link IAction.bind} method.

---

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

The callback invoked when this Action is added to a Pipeline.

---

onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

• name string
• target IRuleTarget
• options RuleProps

Returns

• Rule

Creates an Event that will be triggered whenever the state of this Action changes.

---

protected bound(_scope, _stage, options)

protected bound(_scope: Construct, _stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• _scope Construct
• _stage IStage
• options ActionBindOptions

Returns

• ActionConfig

This is a renamed version of the {@link IAction.bind} method.