Package software.amazon.awscdk.services.codepipeline

Interface IPipeline.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, INotificationRuleSource, INotificationRuleSource.Jsii$Default, IPipeline, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IPipeline.Jsii$Proxy
Enclosing interface:
IPipeline
@Internal public static interface IPipeline.Jsii$Default extends IPipeline, IResource.Jsii$Default, INotificationRuleSource.Jsii$Default
Internal default implementation for IPipeline.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getPipelineArn

      @Stability(Stable) @NotNull default String getPipelineArn()
      The ARN of the Pipeline.
      Specified by:
      getPipelineArn in interface IPipeline

    • getPipelineName

      @Stability(Stable) @NotNull default String getPipelineName()
      The name of the Pipeline.
      Specified by:
      getPipelineName in interface IPipeline

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • bindAsNotificationRuleSource

      @Stability(Stable) @NotNull default NotificationRuleSourceConfig bindAsNotificationRuleSource(@NotNull software.constructs.Construct scope)
      Returns a source configuration for notification rule.

      Specified by:
      bindAsNotificationRuleSource in interface INotificationRuleSource
      Specified by:
      bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default
      Parameters:
      scope - This parameter is required.

    • notifyOn

      @Stability(Stable) @NotNull default INotificationRule notifyOn(@NotNull String id, @NotNull INotificationRuleTarget target, @NotNull PipelineNotifyOnOptions options)
      Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to onEvent API.

      You can also use the methods notifyOnExecutionStateChange, notifyOnAnyStageStateChange, notifyOnAnyActionStateChange and notifyOnAnyManualApprovalStateChange to define rules for these specific event emitted.

      Specified by:
      notifyOn in interface IPipeline
      Parameters:
      id - The id of the CodeStar notification rule. This parameter is required.
      target - The target to register for the CodeStar Notifications destination. This parameter is required.
      options - Customization options for CodeStar notification rule. This parameter is required.
      Returns:
      CodeStar notification rule associated with this build project.

    • notifyOnAnyActionStateChange

      @Stability(Stable) @NotNull default INotificationRule notifyOnAnyActionStateChange(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.

      Specified by:
      notifyOnAnyActionStateChange in interface IPipeline
      Parameters:
      id - Identifier for this notification handler. This parameter is required.
      target - The target to register for the CodeStar Notifications destination. This parameter is required.
      options - Additional options to pass to the notification rule.
      See Also:

    • notifyOnAnyManualApprovalStateChange

      @Stability(Stable) @NotNull default INotificationRule notifyOnAnyManualApprovalStateChange(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.

      Specified by:
      notifyOnAnyManualApprovalStateChange in interface IPipeline
      Parameters:
      id - Identifier for this notification handler. This parameter is required.
      target - The target to register for the CodeStar Notifications destination. This parameter is required.
      options - Additional options to pass to the notification rule.
      See Also:

    • notifyOnAnyStageStateChange

      @Stability(Stable) @NotNull default INotificationRule notifyOnAnyStageStateChange(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.

      Specified by:
      notifyOnAnyStageStateChange in interface IPipeline
      Parameters:
      id - Identifier for this notification handler. This parameter is required.
      target - The target to register for the CodeStar Notifications destination. This parameter is required.
      options - Additional options to pass to the notification rule.
      See Also:

    • notifyOnExecutionStateChange

      @Stability(Stable) @NotNull default INotificationRule notifyOnExecutionStateChange(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.

      Specified by:
      notifyOnExecutionStateChange in interface IPipeline
      Parameters:
      id - Identifier for this notification handler. This parameter is required.
      target - The target to register for the CodeStar Notifications destination. This parameter is required.
      options - Additional options to pass to the notification rule.
      See Also:

    • onEvent

      @Stability(Stable) @NotNull default Rule onEvent(@NotNull String id, @Nullable OnEventOptions options)
      Define an event rule triggered by this CodePipeline.

      Specified by:
      onEvent in interface IPipeline
      Parameters:
      id - Identifier for this event handler. This parameter is required.
      options - Additional options to pass to the event rule.

    • onStateChange

      @Stability(Stable) @NotNull default Rule onStateChange(@NotNull String id, @Nullable OnEventOptions options)
      Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

      Specified by:
      onStateChange in interface IPipeline
      Parameters:
      id - Identifier for this event handler. This parameter is required.
      options - Additional options to pass to the event rule.