io.cloudshiftdev.awscdk.services.ec2.SubnetAttributes.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.ec2

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

/**
 * Example:
 *
 * ```
 * // Supply all properties
 * ISubnet subnet1 = Subnet.fromSubnetAttributes(this, "SubnetFromAttributes",
 * SubnetAttributes.builder()
 * .subnetId("s-1234")
 * .availabilityZone("pub-az-4465")
 * .routeTableId("rt-145")
 * .build());
 * // Supply only subnet id
 * ISubnet subnet2 = Subnet.fromSubnetId(this, "SubnetFromId", "s-1234");
 * ```
 */
public interface SubnetAttributes {
  /**
   * The Availability Zone the subnet is located in.
   *
   * Default: - No AZ information, cannot use AZ selection features
   */
  public fun availabilityZone(): String? = unwrap(this).getAvailabilityZone()

  /**
   * The IPv4 CIDR block associated with the subnet.
   *
   * Default: - No CIDR information, cannot use CIDR filter features
   */
  public fun ipv4CidrBlock(): String? = unwrap(this).getIpv4CidrBlock()

  /**
   * The ID of the route table for this particular subnet.
   *
   * Default: - No route table information, cannot create VPC endpoints
   */
  public fun routeTableId(): String? = unwrap(this).getRouteTableId()

  /**
   * The subnetId for this particular subnet.
   */
  public fun subnetId(): String

  /**
   * A builder for [SubnetAttributes]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param availabilityZone The Availability Zone the subnet is located in.
     */
    public fun availabilityZone(availabilityZone: String)

    /**
     * @param ipv4CidrBlock The IPv4 CIDR block associated with the subnet.
     */
    public fun ipv4CidrBlock(ipv4CidrBlock: String)

    /**
     * @param routeTableId The ID of the route table for this particular subnet.
     */
    public fun routeTableId(routeTableId: String)

    /**
     * @param subnetId The subnetId for this particular subnet. 
     */
    public fun subnetId(subnetId: String)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.services.ec2.SubnetAttributes.Builder =
        software.amazon.awscdk.services.ec2.SubnetAttributes.builder()

    /**
     * @param availabilityZone The Availability Zone the subnet is located in.
     */
    override fun availabilityZone(availabilityZone: String) {
      cdkBuilder.availabilityZone(availabilityZone)
    }

    /**
     * @param ipv4CidrBlock The IPv4 CIDR block associated with the subnet.
     */
    override fun ipv4CidrBlock(ipv4CidrBlock: String) {
      cdkBuilder.ipv4CidrBlock(ipv4CidrBlock)
    }

    /**
     * @param routeTableId The ID of the route table for this particular subnet.
     */
    override fun routeTableId(routeTableId: String) {
      cdkBuilder.routeTableId(routeTableId)
    }

    /**
     * @param subnetId The subnetId for this particular subnet. 
     */
    override fun subnetId(subnetId: String) {
      cdkBuilder.subnetId(subnetId)
    }

    public fun build(): software.amazon.awscdk.services.ec2.SubnetAttributes = cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.ec2.SubnetAttributes,
  ) : CdkObject(cdkObject),
      SubnetAttributes {
    /**
     * The Availability Zone the subnet is located in.
     *
     * Default: - No AZ information, cannot use AZ selection features
     */
    override fun availabilityZone(): String? = unwrap(this).getAvailabilityZone()

    /**
     * The IPv4 CIDR block associated with the subnet.
     *
     * Default: - No CIDR information, cannot use CIDR filter features
     */
    override fun ipv4CidrBlock(): String? = unwrap(this).getIpv4CidrBlock()

    /**
     * The ID of the route table for this particular subnet.
     *
     * Default: - No route table information, cannot create VPC endpoints
     */
    override fun routeTableId(): String? = unwrap(this).getRouteTableId()

    /**
     * The subnetId for this particular subnet.
     */
    override fun subnetId(): String = unwrap(this).getSubnetId()
  }

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

    internal fun wrap(cdkObject: software.amazon.awscdk.services.ec2.SubnetAttributes):
        SubnetAttributes = CdkObjectWrappers.wrap(cdkObject) as? SubnetAttributes ?:
        Wrapper(cdkObject)

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