software.amazon.awscdk.services.codepipeline

Class Pipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.codepipeline.Pipeline

All Implemented Interfaces:

software.amazon.awscdk.services.events.IEventRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.7.8 (build 100f5ad)",
           date="2018-10-26T18:00:29.452Z")
public class Pipeline
extends software.amazon.awscdk.Construct
implements software.amazon.awscdk.services.events.IEventRuleTarget

An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IEventRuleTarget

software.amazon.awscdk.services.events.IEventRuleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Pipeline(software.amazon.awscdk.Construct parent, String name)
	Pipeline(software.amazon.awscdk.Construct parent, String name, PipelineProps props)
protected	Pipeline(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
Stage	addStage(String name) Convenience method for creating a new Stage, and adding it to this Pipeline.
Stage	addStage(String name, CommonStageProps props) Convenience method for creating a new Stage, and adding it to this Pipeline.
void	addToRolePolicy(software.amazon.awscdk.services.iam.PolicyStatement statement) Adds a statement to the pipeline role.
software.amazon.awscdk.services.events.EventRuleTargetProps	asEventRuleTarget(String _ruleArn, String _ruleId) Allows the pipeline to be used as a CloudWatch event rule target.
software.amazon.awscdk.services.s3.BucketRef	getArtifactBucket() Bucket used to store output artifacts
String	getPipelineArn() ARN of this pipeline
String	getPipelineName() The name of the pipeline
String	getPipelineVersion() The version of the pipeline
software.amazon.awscdk.services.iam.Role	getRole() The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with a more specific IAM role.
Number	getStageCount() Get the number of Stages in this Pipeline.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
List<String>	validate() Validate the pipeline structure Validation happens according to the rules documented at https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#pipeline-requirements

Methods inherited from class software.amazon.awscdk.Construct

addChild, addError, addInfo, addMetadata, addMetadata, addMetadata, addWarning, ancestors, ancestors, findChild, getChildren, getContext, getId, getLocked, getMetadata, getParent, getPath, getUniqueId, lock, requireContext, required, setContext, setContext, toString, toTreeString, toTreeString, tryFindChild, unlock, validateTree

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, wait, wait, wait

Constructor Detail

Pipeline

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

Pipeline

public Pipeline(software.amazon.awscdk.Construct parent,
                String name,
                @Nullable
                PipelineProps props)

Pipeline

public Pipeline(software.amazon.awscdk.Construct parent,
                String name)

Method Detail

addStage

public Stage addStage(String name,
                      @Nullable
                      CommonStageProps props)

Convenience method for creating a new Stage, and adding it to this Pipeline.

Parameters:

name - the name of the newly created Stage

props - the optional construction properties of the new Stage

Returns:

the newly created Stage

addStage

public Stage addStage(String name)

Convenience method for creating a new Stage, and adding it to this Pipeline.

Parameters:

name - the name of the newly created Stage

Returns:

the newly created Stage

addToRolePolicy

public void addToRolePolicy(software.amazon.awscdk.services.iam.PolicyStatement statement)

Adds a statement to the pipeline role.

asEventRuleTarget

public software.amazon.awscdk.services.events.EventRuleTargetProps asEventRuleTarget(String _ruleArn,
                                                                                     String _ruleId)

Allows the pipeline to be used as a CloudWatch event rule target. Usage: const pipeline = new Pipeline(this, 'MyPipeline'); const rule = new EventRule(this, 'MyRule', { schedule: 'rate(1 minute)' }); rule.addTarget(pipeline);

Specified by:

asEventRuleTarget in interface software.amazon.awscdk.services.events.IEventRuleTarget

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)

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Parameters:

name - The name of the event rule construct. If you wish to define more than a single onStateChange event, you will need to explicitly specify a name.

target - Initial target to add to the event rule. You can also add targets and customize target inputs by calling `rule.addTarget(target[, options])` after the rule was created.

options - Additional options to pass to the event rule

onStateChange

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

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Parameters:

name - The name of the event rule construct. If you wish to define more than a single onStateChange event, you will need to explicitly specify a name.

target - Initial target to add to the event rule. You can also add targets and customize target inputs by calling `rule.addTarget(target[, options])` after the rule was created.

onStateChange

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

Defines an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Parameters:

name - The name of the event rule construct. If you wish to define more than a single onStateChange event, you will need to explicitly specify a name.

validate

public List<String> validate()

Validate the pipeline structure Validation happens according to the rules documented at https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#pipeline-requirements

Overrides:

validate in class software.amazon.awscdk.Construct

getArtifactBucket

public software.amazon.awscdk.services.s3.BucketRef getArtifactBucket()

Bucket used to store output artifacts

getPipelineArn

public String getPipelineArn()

ARN of this pipeline

getPipelineName

public String getPipelineName()

The name of the pipeline

getPipelineVersion

public String getPipelineVersion()

The version of the pipeline

getRole

public software.amazon.awscdk.services.iam.Role getRole()

The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with a more specific IAM role.

getStageCount

public Number getStageCount()

Get the number of Stages in this Pipeline.