io.cloudshiftdev.awscdk.services.appsync.SourceApiOptions.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.services.appsync

import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.iam.Role
import kotlin.Unit
import kotlin.collections.List

/**
 * Additional API configuration for creating a AppSync Merged API.
 *
 * Example:
 *
 * ```
 * import io.cloudshiftdev.awscdk.*;
 * // first source API
 * GraphqlApi firstApi = GraphqlApi.Builder.create(this, "FirstSourceAPI")
 * .name("FirstSourceAPI")
 * .definition(Definition.fromFile(join(__dirname, "appsync.merged-api-1.graphql")))
 * .build();
 * // second source API
 * GraphqlApi secondApi = GraphqlApi.Builder.create(this, "SecondSourceAPI")
 * .name("SecondSourceAPI")
 * .definition(Definition.fromFile(join(__dirname, "appsync.merged-api-2.graphql")))
 * .build();
 * // Merged API
 * GraphqlApi mergedApi = GraphqlApi.Builder.create(this, "MergedAPI")
 * .name("MergedAPI")
 * .definition(Definition.fromSourceApis(SourceApiOptions.builder()
 * .sourceApis(List.of(SourceApi.builder()
 * .sourceApi(firstApi)
 * .mergeType(MergeType.MANUAL_MERGE)
 * .build(), SourceApi.builder()
 * .sourceApi(secondApi)
 * .mergeType(MergeType.AUTO_MERGE)
 * .build()))
 * .build()))
 * .build();
 * ```
 */
public interface SourceApiOptions {
  /**
   * IAM Role used to validate access to source APIs at runtime and to update the merged API
   * endpoint with the source API changes.
   *
   * Default: - An IAM Role with acccess to source schemas will be created
   */
  public fun mergedApiExecutionRole(): Role? =
      unwrap(this).getMergedApiExecutionRole()?.let(Role::wrap)

  /**
   * Definition of source APIs associated with this Merged API.
   */
  public fun sourceApis(): List

  /**
   * A builder for [SourceApiOptions]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param mergedApiExecutionRole IAM Role used to validate access to source APIs at runtime and
     * to update the merged API endpoint with the source API changes.
     */
    public fun mergedApiExecutionRole(mergedApiExecutionRole: Role)

    /**
     * @param sourceApis Definition of source APIs associated with this Merged API. 
     */
    public fun sourceApis(sourceApis: List)

    /**
     * @param sourceApis Definition of source APIs associated with this Merged API. 
     */
    public fun sourceApis(vararg sourceApis: SourceApi)
  }

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

    /**
     * @param mergedApiExecutionRole IAM Role used to validate access to source APIs at runtime and
     * to update the merged API endpoint with the source API changes.
     */
    override fun mergedApiExecutionRole(mergedApiExecutionRole: Role) {
      cdkBuilder.mergedApiExecutionRole(mergedApiExecutionRole.let(Role.Companion::unwrap))
    }

    /**
     * @param sourceApis Definition of source APIs associated with this Merged API. 
     */
    override fun sourceApis(sourceApis: List) {
      cdkBuilder.sourceApis(sourceApis.map(SourceApi.Companion::unwrap))
    }

    /**
     * @param sourceApis Definition of source APIs associated with this Merged API. 
     */
    override fun sourceApis(vararg sourceApis: SourceApi): Unit = sourceApis(sourceApis.toList())

    public fun build(): software.amazon.awscdk.services.appsync.SourceApiOptions =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.appsync.SourceApiOptions,
  ) : CdkObject(cdkObject),
      SourceApiOptions {
    /**
     * IAM Role used to validate access to source APIs at runtime and to update the merged API
     * endpoint with the source API changes.
     *
     * Default: - An IAM Role with acccess to source schemas will be created
     */
    override fun mergedApiExecutionRole(): Role? =
        unwrap(this).getMergedApiExecutionRole()?.let(Role::wrap)

    /**
     * Definition of source APIs associated with this Merged API.
     */
    override fun sourceApis(): List = unwrap(this).getSourceApis().map(SourceApi::wrap)
  }

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

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

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