software.amazon.awscdk.services.codepipeline.api

Interface IPipeline

All Superinterfaces:

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

All Known Implementing Classes:

IPipeline.Jsii$Proxy

@Generated(value="jsii-pacmak/0.7.14 (build 91853ce)",
           date="2019-02-07T16:58:30.611Z")
public interface IPipeline
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.IConstruct, software.amazon.awscdk.services.events.IEventRuleTarget

The abstract view of an AWS CodePipeline as required and used by Actions. It extends events.IEventRuleTarget, so this interface can be used as a Target for CloudWatch Events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPipeline.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getPipelineArn() The ARN of the Pipeline.
String	getPipelineName() The name of the Pipeline.
software.amazon.awscdk.services.iam.Role	getRole() The service Role of the Pipeline.
void	grantBucketRead() Grants read permissions to the Pipeline's S3 Bucket to the given Identity.
void	grantBucketRead(software.amazon.awscdk.services.iam.IPrincipal identity) Grants read permissions to the Pipeline's S3 Bucket to the given Identity.
void	grantBucketReadWrite() Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity.
void	grantBucketReadWrite(software.amazon.awscdk.services.iam.IPrincipal identity) Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity.

Methods inherited from interface software.amazon.awscdk.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IDependable

getDependencyRoots

Methods inherited from interface software.amazon.awscdk.services.events.IEventRuleTarget

asEventRuleTarget

Method Detail

getPipelineArn

String getPipelineArn()

The ARN of the Pipeline.

getPipelineName

String getPipelineName()

The name of the Pipeline.

getRole

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

The service Role of the Pipeline.

grantBucketRead

void grantBucketRead(@Nullable
                     software.amazon.awscdk.services.iam.IPrincipal identity)

Grants read permissions to the Pipeline's S3 Bucket to the given Identity.

Parameters:

identity - the IAM Identity to grant the permissions to

grantBucketRead

void grantBucketRead()

Grants read permissions to the Pipeline's S3 Bucket to the given Identity.

grantBucketReadWrite

void grantBucketReadWrite(@Nullable
                          software.amazon.awscdk.services.iam.IPrincipal identity)

Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity.

Parameters:

identity - the IAM Identity to grant the permissions to

grantBucketReadWrite

void grantBucketReadWrite()

Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity.