io.cloudshiftdev.awscdk.services.codestarnotifications.INotificationRule.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
There is a newer version: 0.10.0
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.codestarnotifications

import io.cloudshiftdev.awscdk.IResource
import io.cloudshiftdev.awscdk.RemovalPolicy
import io.cloudshiftdev.awscdk.ResourceEnvironment
import io.cloudshiftdev.awscdk.Stack
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.constructs.Node
import kotlin.Boolean
import kotlin.String

/**
 * Represents a notification rule.
 */
public interface INotificationRule : IResource {
  /**
   * Adds target to notification rule.
   *
   * @return boolean - return true if it had any effect
   * @param target The SNS topic or AWS Chatbot Slack target. 
   */
  public fun addTarget(target: INotificationRuleTarget): Boolean

  /**
   * The ARN of the notification rule (i.e.
   * arn:aws:codestar-notifications:::notificationrule/01234abcde).
   */
  public fun notificationRuleArn(): String

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.codestarnotifications.INotificationRule,
  ) : CdkObject(cdkObject),
      INotificationRule {
    /**
     * Adds target to notification rule.
     *
     * @return boolean - return true if it had any effect
     * @param target The SNS topic or AWS Chatbot Slack target. 
     */
    override fun addTarget(target: INotificationRuleTarget): Boolean =
        unwrap(this).addTarget(target.let(INotificationRuleTarget.Companion::unwrap))

    /**
     * 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`).
     *
     * @param policy 
     */
    override fun applyRemovalPolicy(policy: RemovalPolicy) {
      unwrap(this).applyRemovalPolicy(policy.let(RemovalPolicy.Companion::unwrap))
    }

    /**
     * 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.
     */
    override fun env(): ResourceEnvironment = unwrap(this).getEnv().let(ResourceEnvironment::wrap)

    override fun node(): Node = unwrap(this).getNode().let(Node::wrap)

    /**
     * The ARN of the notification rule (i.e.
     * arn:aws:codestar-notifications:::notificationrule/01234abcde).
     */
    override fun notificationRuleArn(): String = unwrap(this).getNotificationRuleArn()

    /**
     * The stack in which this resource is defined.
     */
    override fun stack(): Stack = unwrap(this).getStack().let(Stack::wrap)
  }

  public companion object {
    internal
        fun wrap(cdkObject: software.amazon.awscdk.services.codestarnotifications.INotificationRule):
        INotificationRule = CdkObjectWrappers.wrap(cdkObject) as? INotificationRule ?:
        Wrapper(cdkObject)

    internal fun unwrap(wrapped: INotificationRule):
        software.amazon.awscdk.services.codestarnotifications.INotificationRule = (wrapped as
        CdkObject).cdkObject as
        software.amazon.awscdk.services.codestarnotifications.INotificationRule
  }
}