All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.cloudshiftdev.awscdk.services.cloudfront.ResponseHeadersPolicy.kt Maven / Gradle / Ivy

There is a newer version: 0.10.0
Show newest version
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.cloudfront

import io.cloudshiftdev.awscdk.Resource
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct

/**
 * A Response Headers Policy configuration.
 *
 * Example:
 *
 * ```
 * // Using an existing managed response headers policy
 * S3Origin bucketOrigin;
 * Distribution.Builder.create(this, "myDistManagedPolicy")
 * .defaultBehavior(BehaviorOptions.builder()
 * .origin(bucketOrigin)
 * .responseHeadersPolicy(ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS)
 * .build())
 * .build();
 * // Creating a custom response headers policy -- all parameters optional
 * ResponseHeadersPolicy myResponseHeadersPolicy = ResponseHeadersPolicy.Builder.create(this,
 * "ResponseHeadersPolicy")
 * .responseHeadersPolicyName("MyPolicy")
 * .comment("A default policy")
 * .corsBehavior(ResponseHeadersCorsBehavior.builder()
 * .accessControlAllowCredentials(false)
 * .accessControlAllowHeaders(List.of("X-Custom-Header-1", "X-Custom-Header-2"))
 * .accessControlAllowMethods(List.of("GET", "POST"))
 * .accessControlAllowOrigins(List.of("*"))
 * .accessControlExposeHeaders(List.of("X-Custom-Header-1", "X-Custom-Header-2"))
 * .accessControlMaxAge(Duration.seconds(600))
 * .originOverride(true)
 * .build())
 * .customHeadersBehavior(ResponseCustomHeadersBehavior.builder()
 * .customHeaders(List.of(ResponseCustomHeader.builder().header("X-Amz-Date").value("some-value").override(true).build(),
 * ResponseCustomHeader.builder().header("X-Amz-Security-Token").value("some-value").override(false).build()))
 * .build())
 * .securityHeadersBehavior(ResponseSecurityHeadersBehavior.builder()
 * .contentSecurityPolicy(ResponseHeadersContentSecurityPolicy.builder().contentSecurityPolicy("default-src
 * https:;").override(true).build())
 * .contentTypeOptions(ResponseHeadersContentTypeOptions.builder().override(true).build())
 * .frameOptions(ResponseHeadersFrameOptions.builder().frameOption(HeadersFrameOption.DENY).override(true).build())
 * .referrerPolicy(ResponseHeadersReferrerPolicy.builder().referrerPolicy(HeadersReferrerPolicy.NO_REFERRER).override(true).build())
 * .strictTransportSecurity(ResponseHeadersStrictTransportSecurity.builder().accessControlMaxAge(Duration.seconds(600)).includeSubdomains(true).override(true).build())
 * .xssProtection(ResponseHeadersXSSProtection.builder().protection(true).modeBlock(false).reportUri("https://example.com/csp-report").override(true).build())
 * .build())
 * .removeHeaders(List.of("Server"))
 * .serverTimingSamplingRate(50)
 * .build();
 * Distribution.Builder.create(this, "myDistCustomPolicy")
 * .defaultBehavior(BehaviorOptions.builder()
 * .origin(bucketOrigin)
 * .responseHeadersPolicy(myResponseHeadersPolicy)
 * .build())
 * .build();
 * ```
 */
public open class ResponseHeadersPolicy(
  cdkObject: software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy,
) : Resource(cdkObject),
    IResponseHeadersPolicy {
  public constructor(scope: CloudshiftdevConstructsConstruct, id: String) :
      this(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
      id)
  )

  public constructor(
    scope: CloudshiftdevConstructsConstruct,
    id: String,
    props: ResponseHeadersPolicyProps,
  ) :
      this(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
      id, props.let(ResponseHeadersPolicyProps.Companion::unwrap))
  )

  public constructor(
    scope: CloudshiftdevConstructsConstruct,
    id: String,
    props: ResponseHeadersPolicyProps.Builder.() -> Unit,
  ) : this(scope, id, ResponseHeadersPolicyProps(props)
  )

  /**
   * The ID of the response headers policy.
   */
  public override fun responseHeadersPolicyId(): String = unwrap(this).getResponseHeadersPolicyId()

  /**
   * A fluent builder for [io.cloudshiftdev.awscdk.services.cloudfront.ResponseHeadersPolicy].
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * A comment to describe the response headers policy.
     *
     * Default: - no comment
     *
     * @param comment A comment to describe the response headers policy. 
     */
    public fun comment(comment: String)

    /**
     * A configuration for a set of HTTP response headers that are used for cross-origin resource
     * sharing (CORS).
     *
     * Default: - no cors behavior
     *
     * @param corsBehavior A configuration for a set of HTTP response headers that are used for
     * cross-origin resource sharing (CORS). 
     */
    public fun corsBehavior(corsBehavior: ResponseHeadersCorsBehavior)

    /**
     * A configuration for a set of HTTP response headers that are used for cross-origin resource
     * sharing (CORS).
     *
     * Default: - no cors behavior
     *
     * @param corsBehavior A configuration for a set of HTTP response headers that are used for
     * cross-origin resource sharing (CORS). 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("ad2af5fbd83f040932aa29ddbb986fde55e2d148fa3edb5d4b1eff454b8a8505")
    public fun corsBehavior(corsBehavior: ResponseHeadersCorsBehavior.Builder.() -> Unit)

    /**
     * A configuration for a set of custom HTTP response headers.
     *
     * Default: - no custom headers behavior
     *
     * @param customHeadersBehavior A configuration for a set of custom HTTP response headers. 
     */
    public fun customHeadersBehavior(customHeadersBehavior: ResponseCustomHeadersBehavior)

    /**
     * A configuration for a set of custom HTTP response headers.
     *
     * Default: - no custom headers behavior
     *
     * @param customHeadersBehavior A configuration for a set of custom HTTP response headers. 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("ab2f2333b49f38c2836f76f275cc00c10028065625276a721d6053832074377b")
    public
        fun customHeadersBehavior(customHeadersBehavior: ResponseCustomHeadersBehavior.Builder.() -> Unit)

    /**
     * A list of HTTP response headers that CloudFront removes from HTTP responses that it sends to
     * viewers.
     *
     * Default: - no headers are removed
     *
     * @param removeHeaders A list of HTTP response headers that CloudFront removes from HTTP
     * responses that it sends to viewers. 
     */
    public fun removeHeaders(removeHeaders: List)

    /**
     * A list of HTTP response headers that CloudFront removes from HTTP responses that it sends to
     * viewers.
     *
     * Default: - no headers are removed
     *
     * @param removeHeaders A list of HTTP response headers that CloudFront removes from HTTP
     * responses that it sends to viewers. 
     */
    public fun removeHeaders(vararg removeHeaders: String)

    /**
     * A unique name to identify the response headers policy.
     *
     * Default: - generated from the `id`
     *
     * @param responseHeadersPolicyName A unique name to identify the response headers policy. 
     */
    public fun responseHeadersPolicyName(responseHeadersPolicyName: String)

    /**
     * A configuration for a set of security-related HTTP response headers.
     *
     * Default: - no security headers behavior
     *
     * @param securityHeadersBehavior A configuration for a set of security-related HTTP response
     * headers. 
     */
    public fun securityHeadersBehavior(securityHeadersBehavior: ResponseSecurityHeadersBehavior)

    /**
     * A configuration for a set of security-related HTTP response headers.
     *
     * Default: - no security headers behavior
     *
     * @param securityHeadersBehavior A configuration for a set of security-related HTTP response
     * headers. 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("850766b95b6b44bdd5235525c7ce0800dd9a6a339e245395151303df303cefcc")
    public
        fun securityHeadersBehavior(securityHeadersBehavior: ResponseSecurityHeadersBehavior.Builder.() -> Unit)

    /**
     * The percentage of responses that you want CloudFront to add the Server-Timing header to.
     *
     * Default: - no Server-Timing header is added to HTTP responses
     *
     * @param serverTimingSamplingRate The percentage of responses that you want CloudFront to add
     * the Server-Timing header to. 
     */
    public fun serverTimingSamplingRate(serverTimingSamplingRate: Number)
  }

  private class BuilderImpl(
    scope: SoftwareConstructsConstruct,
    id: String,
  ) : Builder {
    private val cdkBuilder: software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.Builder
        = software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.Builder.create(scope, id)

    /**
     * A comment to describe the response headers policy.
     *
     * Default: - no comment
     *
     * @param comment A comment to describe the response headers policy. 
     */
    override fun comment(comment: String) {
      cdkBuilder.comment(comment)
    }

    /**
     * A configuration for a set of HTTP response headers that are used for cross-origin resource
     * sharing (CORS).
     *
     * Default: - no cors behavior
     *
     * @param corsBehavior A configuration for a set of HTTP response headers that are used for
     * cross-origin resource sharing (CORS). 
     */
    override fun corsBehavior(corsBehavior: ResponseHeadersCorsBehavior) {
      cdkBuilder.corsBehavior(corsBehavior.let(ResponseHeadersCorsBehavior.Companion::unwrap))
    }

    /**
     * A configuration for a set of HTTP response headers that are used for cross-origin resource
     * sharing (CORS).
     *
     * Default: - no cors behavior
     *
     * @param corsBehavior A configuration for a set of HTTP response headers that are used for
     * cross-origin resource sharing (CORS). 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("ad2af5fbd83f040932aa29ddbb986fde55e2d148fa3edb5d4b1eff454b8a8505")
    override fun corsBehavior(corsBehavior: ResponseHeadersCorsBehavior.Builder.() -> Unit): Unit =
        corsBehavior(ResponseHeadersCorsBehavior(corsBehavior))

    /**
     * A configuration for a set of custom HTTP response headers.
     *
     * Default: - no custom headers behavior
     *
     * @param customHeadersBehavior A configuration for a set of custom HTTP response headers. 
     */
    override fun customHeadersBehavior(customHeadersBehavior: ResponseCustomHeadersBehavior) {
      cdkBuilder.customHeadersBehavior(customHeadersBehavior.let(ResponseCustomHeadersBehavior.Companion::unwrap))
    }

    /**
     * A configuration for a set of custom HTTP response headers.
     *
     * Default: - no custom headers behavior
     *
     * @param customHeadersBehavior A configuration for a set of custom HTTP response headers. 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("ab2f2333b49f38c2836f76f275cc00c10028065625276a721d6053832074377b")
    override
        fun customHeadersBehavior(customHeadersBehavior: ResponseCustomHeadersBehavior.Builder.() -> Unit):
        Unit = customHeadersBehavior(ResponseCustomHeadersBehavior(customHeadersBehavior))

    /**
     * A list of HTTP response headers that CloudFront removes from HTTP responses that it sends to
     * viewers.
     *
     * Default: - no headers are removed
     *
     * @param removeHeaders A list of HTTP response headers that CloudFront removes from HTTP
     * responses that it sends to viewers. 
     */
    override fun removeHeaders(removeHeaders: List) {
      cdkBuilder.removeHeaders(removeHeaders)
    }

    /**
     * A list of HTTP response headers that CloudFront removes from HTTP responses that it sends to
     * viewers.
     *
     * Default: - no headers are removed
     *
     * @param removeHeaders A list of HTTP response headers that CloudFront removes from HTTP
     * responses that it sends to viewers. 
     */
    override fun removeHeaders(vararg removeHeaders: String): Unit =
        removeHeaders(removeHeaders.toList())

    /**
     * A unique name to identify the response headers policy.
     *
     * Default: - generated from the `id`
     *
     * @param responseHeadersPolicyName A unique name to identify the response headers policy. 
     */
    override fun responseHeadersPolicyName(responseHeadersPolicyName: String) {
      cdkBuilder.responseHeadersPolicyName(responseHeadersPolicyName)
    }

    /**
     * A configuration for a set of security-related HTTP response headers.
     *
     * Default: - no security headers behavior
     *
     * @param securityHeadersBehavior A configuration for a set of security-related HTTP response
     * headers. 
     */
    override fun securityHeadersBehavior(securityHeadersBehavior: ResponseSecurityHeadersBehavior) {
      cdkBuilder.securityHeadersBehavior(securityHeadersBehavior.let(ResponseSecurityHeadersBehavior.Companion::unwrap))
    }

    /**
     * A configuration for a set of security-related HTTP response headers.
     *
     * Default: - no security headers behavior
     *
     * @param securityHeadersBehavior A configuration for a set of security-related HTTP response
     * headers. 
     */
    @kotlin.Suppress("INAPPLICABLE_JVM_NAME")
    @JvmName("850766b95b6b44bdd5235525c7ce0800dd9a6a339e245395151303df303cefcc")
    override
        fun securityHeadersBehavior(securityHeadersBehavior: ResponseSecurityHeadersBehavior.Builder.() -> Unit):
        Unit = securityHeadersBehavior(ResponseSecurityHeadersBehavior(securityHeadersBehavior))

    /**
     * The percentage of responses that you want CloudFront to add the Server-Timing header to.
     *
     * Default: - no Server-Timing header is added to HTTP responses
     *
     * @param serverTimingSamplingRate The percentage of responses that you want CloudFront to add
     * the Server-Timing header to. 
     */
    override fun serverTimingSamplingRate(serverTimingSamplingRate: Number) {
      cdkBuilder.serverTimingSamplingRate(serverTimingSamplingRate)
    }

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

  public companion object {
    public val CORS_ALLOW_ALL_ORIGINS: IResponseHeadersPolicy =
        IResponseHeadersPolicy.wrap(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS)

    public val CORS_ALLOW_ALL_ORIGINS_AND_SECURITY_HEADERS: IResponseHeadersPolicy =
        IResponseHeadersPolicy.wrap(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS_AND_SECURITY_HEADERS)

    public val CORS_ALLOW_ALL_ORIGINS_WITH_PREFLIGHT: IResponseHeadersPolicy =
        IResponseHeadersPolicy.wrap(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS_WITH_PREFLIGHT)

    public val CORS_ALLOW_ALL_ORIGINS_WITH_PREFLIGHT_AND_SECURITY_HEADERS: IResponseHeadersPolicy =
        IResponseHeadersPolicy.wrap(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS_WITH_PREFLIGHT_AND_SECURITY_HEADERS)

    public val SECURITY_HEADERS: IResponseHeadersPolicy =
        IResponseHeadersPolicy.wrap(software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.SECURITY_HEADERS)

    public fun fromResponseHeadersPolicyId(
      scope: CloudshiftdevConstructsConstruct,
      id: String,
      responseHeadersPolicyId: String,
    ): IResponseHeadersPolicy =
        software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy.fromResponseHeadersPolicyId(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
        id, responseHeadersPolicyId).let(IResponseHeadersPolicy::wrap)

    public operator fun invoke(
      scope: CloudshiftdevConstructsConstruct,
      id: String,
      block: Builder.() -> Unit = {},
    ): ResponseHeadersPolicy {
      val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
      return ResponseHeadersPolicy(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicy):
        ResponseHeadersPolicy = ResponseHeadersPolicy(cdkObject)

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




© 2015 - 2025 Weber Informatics LLC | Privacy Policy