software.amazon.awscdk.services.codepipeline.api

Class Action

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.api.Action

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

BuildAction, DeployAction, SourceAction, TestAction

@Generated(value="jsii-pacmak/0.8.2 (build e9eb3c9)",
           date="2019-03-28T21:35:49.710Z")
public abstract class Action
extends software.amazon.jsii.JsiiObject

Low-level class for generic CodePipeline Actions. It is recommended that concrete types are used instead, such as codecommit.PipelineSourceAction or codebuild.PipelineBuildAction.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Action(ActionProps props)
protected	Action(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
protected Action	addInputArtifact(Artifact artifact)
protected Artifact	addOutputArtifact(String name)
protected abstract void	bind(IStage stage, software.amazon.awscdk.Construct scope) The method called when an Action is attached to a Pipeline.
String	getActionName()
ActionCategory	getCategory() The category of the action.
Object	getConfiguration() The action's configuration.
String	getOwner()
String	getProvider() The service provider that the action calls.
String	getRegion() The AWS region the given Action resides in.
software.amazon.awscdk.services.iam.IRole	getRole() The service role that is assumed during execution of action.
Number	getRunOrder() The order in which AWS CodePipeline runs this action.
protected software.amazon.awscdk.Construct	getScope() Retrieves the Construct scope of this Action.
String	getVersion()
software.amazon.awscdk.services.events.EventRule	onStateChange(String name)
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target)
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options)
protected List<String>	validate()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Action

protected Action(software.amazon.jsii.JsiiObject.InitializationMode mode)

Action

public Action(ActionProps props)

Method Detail

addInputArtifact

protected Action addInputArtifact(Artifact artifact)

addOutputArtifact

protected Artifact addOutputArtifact(String name)

bind

protected abstract void bind(IStage stage,
                             software.amazon.awscdk.Construct scope)

The method called when an Action is attached to a Pipeline. This method is guaranteed to be called only once for each Action instance.

Parameters:

stage - the stage this action has been added to (includes a reference to the pipeline as well)

scope - the scope construct for this action, can be used by the action implementation to create any resources it needs to work correctly

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.EventRuleProps options)

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target)

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name)

validate

protected List<String> validate()

getActionName

public String getActionName()

getCategory

public ActionCategory getCategory()

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

getOwner

public String getOwner()

getProvider

public String getProvider()

The service provider that the action calls.

getRunOrder

public Number getRunOrder()

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

getScope

protected software.amazon.awscdk.Construct getScope()

Retrieves the Construct scope of this Action. Only available after the Action has been added to a Stage, and that Stage to a Pipeline.

getVersion

public String getVersion()

getConfiguration

@Nullable
public Object getConfiguration()

The action's configuration. These are key-value pairs that specify input values for an action. For more information, see the AWS CodePipeline User Guide. http://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

getRegion

@Nullable
public String getRegion()

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 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.

getRole

@Nullable
public software.amazon.awscdk.services.iam.IRole getRole()

The service role that is assumed during execution of action. This role is not mandatory, however more advanced configuration may require specifying it.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html