io.cloudshiftdev.awscdk.cxapi.Environment.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
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.cxapi

import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.String
import kotlin.Unit

/**
 * Models an AWS execution environment, for use within the CDK toolkit.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.cxapi.*;
 * Environment environment = Environment.builder()
 * .account("account")
 * .name("name")
 * .region("region")
 * .build();
 * ```
 */
public interface Environment {
  /**
   * The AWS account this environment deploys into.
   */
  public fun account(): String

  /**
   * The arbitrary name of this environment (user-set, or at least user-meaningful).
   */
  public fun name(): String

  /**
   * The AWS region name where this environment deploys into.
   */
  public fun region(): String

  /**
   * A builder for [Environment]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param account The AWS account this environment deploys into. 
     */
    public fun account(account: String)

    /**
     * @param name The arbitrary name of this environment (user-set, or at least user-meaningful). 
     */
    public fun name(name: String)

    /**
     * @param region The AWS region name where this environment deploys into. 
     */
    public fun region(region: String)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.cxapi.Environment.Builder =
        software.amazon.awscdk.cxapi.Environment.builder()

    /**
     * @param account The AWS account this environment deploys into. 
     */
    override fun account(account: String) {
      cdkBuilder.account(account)
    }

    /**
     * @param name The arbitrary name of this environment (user-set, or at least user-meaningful). 
     */
    override fun name(name: String) {
      cdkBuilder.name(name)
    }

    /**
     * @param region The AWS region name where this environment deploys into. 
     */
    override fun region(region: String) {
      cdkBuilder.region(region)
    }

    public fun build(): software.amazon.awscdk.cxapi.Environment = cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.cxapi.Environment,
  ) : CdkObject(cdkObject),
      Environment {
    /**
     * The AWS account this environment deploys into.
     */
    override fun account(): String = unwrap(this).getAccount()

    /**
     * The arbitrary name of this environment (user-set, or at least user-meaningful).
     */
    override fun name(): String = unwrap(this).getName()

    /**
     * The AWS region name where this environment deploys into.
     */
    override fun region(): String = unwrap(this).getRegion()
  }

  public companion object {
    public operator fun invoke(block: Builder.() -> Unit = {}): Environment {
      val builderImpl = BuilderImpl()
      return Wrapper(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.cxapi.Environment): Environment =
        CdkObjectWrappers.wrap(cdkObject) as? Environment ?: Wrapper(cdkObject)

    internal fun unwrap(wrapped: Environment): software.amazon.awscdk.cxapi.Environment = (wrapped
        as CdkObject).cdkObject as software.amazon.awscdk.cxapi.Environment
  }
}