io.cloudshiftdev.awscdk.services.cloudfront.ResponseCustomHeader.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.cloudfront

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

/**
 * An HTTP response header name and its value.
 *
 * CloudFront includes this header in HTTP responses that it sends for requests that match a cache
 * behavior that’s associated with this response headers policy.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.services.cloudfront.*;
 * ResponseCustomHeader responseCustomHeader = ResponseCustomHeader.builder()
 * .header("header")
 * .override(false)
 * .value("value")
 * .build();
 * ```
 */
public interface ResponseCustomHeader {
  /**
   * The HTTP response header name.
   */
  public fun `header`(): String

  /**
   * A Boolean that determines whether CloudFront overrides a response header with the same name
   * received from the origin with the header specified here.
   */
  public fun `override`(): Boolean

  /**
   * The value for the HTTP response header.
   */
  public fun `value`(): String

  /**
   * A builder for [ResponseCustomHeader]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param header The HTTP response header name. 
     */
    public fun `header`(`header`: String)

    /**
     * @param override A Boolean that determines whether CloudFront overrides a response header with
     * the same name received from the origin with the header specified here. 
     */
    public fun `override`(`override`: Boolean)

    /**
     * @param value The value for the HTTP response header. 
     */
    public fun `value`(`value`: String)
  }

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

    /**
     * @param header The HTTP response header name. 
     */
    override fun `header`(`header`: String) {
      cdkBuilder.`header`(`header`)
    }

    /**
     * @param override A Boolean that determines whether CloudFront overrides a response header with
     * the same name received from the origin with the header specified here. 
     */
    override fun `override`(`override`: Boolean) {
      cdkBuilder.`override`(`override`)
    }

    /**
     * @param value The value for the HTTP response header. 
     */
    override fun `value`(`value`: String) {
      cdkBuilder.`value`(`value`)
    }

    public fun build(): software.amazon.awscdk.services.cloudfront.ResponseCustomHeader =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.cloudfront.ResponseCustomHeader,
  ) : CdkObject(cdkObject),
      ResponseCustomHeader {
    /**
     * The HTTP response header name.
     */
    override fun `header`(): String = unwrap(this).getHeader()

    /**
     * A Boolean that determines whether CloudFront overrides a response header with the same name
     * received from the origin with the header specified here.
     */
    override fun `override`(): Boolean = unwrap(this).getOverride()

    /**
     * The value for the HTTP response header.
     */
    override fun `value`(): String = unwrap(this).getValue()
  }

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

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

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