class S3DeployAction

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

Implements IAction

Extends Action

Deploys the sourceArtifact to Amazon S3.

Example

const sourceOutput = new codepipeline.Artifact();
const targetBucket = new s3.Bucket(this, 'MyBucket');

const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const deployAction = new codepipeline_actions.S3DeployAction({
  actionName: 'S3Deploy',
  bucket: targetBucket,
  input: sourceOutput,
});
const deployStage = pipeline.addStage({
  stageName: 'Deploy',
  actions: [deployAction],
});

Initializer

new S3DeployAction(props: S3DeployActionProps)

Parameters

• props S3DeployActionProps

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.