io.cloudshiftdev.awscdk.services.codepipeline.actions.CacheControl.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.codepipeline.actions

import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkObject
import kotlin.String

/**
 * Used for HTTP cache-control header, which influences downstream caches.
 *
 * Use the provided static factory methods to construct instances of this class.
 * Used in the `S3DeployActionProps.cacheControl` property.
 *
 * 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.codepipeline.actions.*;
 * CacheControl cacheControl = CacheControl.fromString("s");
 * ```
 *
 * [Documentation](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9)
 */
public open class CacheControl(
  cdkObject: software.amazon.awscdk.services.codepipeline.actions.CacheControl,
) : CdkObject(cdkObject) {
  /**
   * the actual text value of the created directive.
   */
  public open fun `value`(): String = unwrap(this).getValue()

  /**
   * the actual text value of the created directive.
   */
  public open fun `value`(`value`: String) {
    unwrap(this).setValue(`value`)
  }

  public companion object {
    public fun fromString(s: String): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.fromString(s).let(CacheControl::wrap)

    public fun immutable(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.immutable().let(CacheControl::wrap)

    public fun maxAge(t: Duration): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.maxAge(t.let(Duration.Companion::unwrap)).let(CacheControl::wrap)

    public fun mustRevalidate(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.mustRevalidate().let(CacheControl::wrap)

    public fun mustUnderstand(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.mustUnderstand().let(CacheControl::wrap)

    public fun noCache(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.noCache().let(CacheControl::wrap)

    public fun noStore(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.noStore().let(CacheControl::wrap)

    public fun noTransform(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.noTransform().let(CacheControl::wrap)

    public fun `private`(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.setPrivate().let(CacheControl::wrap)

    public fun proxyRevalidate(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.proxyRevalidate().let(CacheControl::wrap)

    public fun `public`(): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.setPublic().let(CacheControl::wrap)

    public fun sMaxAge(t: Duration): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.sMaxAge(t.let(Duration.Companion::unwrap)).let(CacheControl::wrap)

    public fun staleIfError(t: Duration): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.staleIfError(t.let(Duration.Companion::unwrap)).let(CacheControl::wrap)

    public fun staleWhileRevalidate(t: Duration): CacheControl =
        software.amazon.awscdk.services.codepipeline.actions.CacheControl.staleWhileRevalidate(t.let(Duration.Companion::unwrap)).let(CacheControl::wrap)

    internal fun wrap(cdkObject: software.amazon.awscdk.services.codepipeline.actions.CacheControl):
        CacheControl = CacheControl(cdkObject)

    internal fun unwrap(wrapped: CacheControl):
        software.amazon.awscdk.services.codepipeline.actions.CacheControl = wrapped.cdkObject as
        software.amazon.awscdk.services.codepipeline.actions.CacheControl
  }
}