aws-cdk-lib.aws_codepipeline_actions.S3DeployAction

class S3DeployAction

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.S3DeployAction
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#S3DeployAction
Javasoftware.amazon.awscdk.services.codepipeline.actions.S3DeployAction
Pythonaws_cdk.aws_codepipeline_actions.S3DeployAction
TypeScript (source)aws-cdk-lib » 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 key: kms.IKey = new kms.Key(stack, 'EnvVarEncryptKey', {
  description: 'sample key',
});

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

Initializer

new S3DeployAction(props: S3DeployActionProps)

Parameters

  • props S3DeployActionProps

Properties

NameTypeDescription
actionPropertiesActionPropertiesThe 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 bind callback.

Methods

NameDescription
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 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 IAction.bind method.