Package software.amazon.awscdk.services.pipes.alpha

Interface IPipe.Jsii$Default

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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

    IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.alpha.IPipe

    IPipe.Jsii$Default, IPipe.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    default String
    getPipeArn()
    (experimental) The ARN of the pipe.
    default String
    getPipeName()
    (experimental) The name of the pipe.
    default IRole
    getPipeRole()
    (experimental) The role used by the pipe.
    default Stack
    getStack()
    The stack in which this resource is defined.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • 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 in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      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

    • getPipeArn

      @Stability(Experimental) @NotNull default String getPipeArn()
      (experimental) The ARN of the pipe.
      Specified by:
      getPipeArn in interface IPipe

    • getPipeName

      @Stability(Experimental) @NotNull default String getPipeName()
      (experimental) The name of the pipe.
      Specified by:
      getPipeName in interface IPipe

    • getPipeRole

      @Stability(Experimental) @NotNull default IRole getPipeRole()
      (experimental) The role used by the pipe.

      For imported pipes it assumes that the default role is used.

      Specified by:
      getPipeRole in interface IPipe

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