io.cloudshiftdev.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.cloudfront.origins
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.cloudfront.AccessLevel
import io.cloudshiftdev.awscdk.services.cloudfront.IOriginAccessControl
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Properties for configuring a S3 origin with OAC.
*
* Example:
*
* ```
* Bucket myBucket = new Bucket(this, "myBucket");
* IOrigin s3Origin = S3BucketOrigin.withOriginAccessControl(myBucket,
* S3BucketOriginWithOACProps.builder()
* .originAccessLevels(List.of(AccessLevel.READ, AccessLevel.WRITE, AccessLevel.DELETE))
* .build());
* ```
*/
public interface S3BucketOriginWithOACProps : S3BucketOriginBaseProps {
/**
* An optional Origin Access Control.
*
* Default: - an Origin Access Control will be created.
*/
public fun originAccessControl(): IOriginAccessControl? =
unwrap(this).getOriginAccessControl()?.let(IOriginAccessControl::wrap)
/**
* The level of permissions granted in the bucket policy and key policy (if applicable) to the
* CloudFront distribution.
*
* Default: [AccessLevel.READ]
*/
public fun originAccessLevels(): List =
unwrap(this).getOriginAccessLevels()?.map(AccessLevel::wrap) ?: emptyList()
/**
* A builder for [S3BucketOriginWithOACProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param connectionAttempts The number of times that CloudFront attempts to connect to the
* origin;.
* valid values are 1, 2, or 3 attempts.
*/
public fun connectionAttempts(connectionAttempts: Number)
/**
* @param connectionTimeout The number of seconds that CloudFront waits when trying to establish
* a connection to the origin.
* Valid values are 1-10 seconds, inclusive.
*/
public fun connectionTimeout(connectionTimeout: Duration)
/**
* @param customHeaders A list of HTTP header names and values that CloudFront adds to requests
* it sends to the origin.
*/
public fun customHeaders(customHeaders: Map)
/**
* @param originAccessControl An optional Origin Access Control.
*/
public fun originAccessControl(originAccessControl: IOriginAccessControl)
/**
* @param originAccessControlId The unique identifier of an origin access control for this
* origin.
*/
public fun originAccessControlId(originAccessControlId: String)
/**
* @param originAccessLevels The level of permissions granted in the bucket policy and key
* policy (if applicable) to the CloudFront distribution.
*/
public fun originAccessLevels(originAccessLevels: List)
/**
* @param originAccessLevels The level of permissions granted in the bucket policy and key
* policy (if applicable) to the CloudFront distribution.
*/
public fun originAccessLevels(vararg originAccessLevels: AccessLevel)
/**
* @param originId A unique identifier for the origin.
* This value must be unique within the distribution.
*/
public fun originId(originId: String)
/**
* @param originPath An optional path that CloudFront appends to the origin domain name when
* CloudFront requests content from the origin.
* Must begin, but not end, with '/' (e.g., '/production/images').
*/
public fun originPath(originPath: String)
/**
* @param originShieldEnabled Origin Shield is enabled by setting originShieldRegion to a valid
* region, after this to disable Origin Shield again you must set this flag to false.
*/
public fun originShieldEnabled(originShieldEnabled: Boolean)
/**
* @param originShieldRegion When you enable Origin Shield in the AWS Region that has the lowest
* latency to your origin, you can get better network performance.
*/
public fun originShieldRegion(originShieldRegion: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps.Builder =
software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps.builder()
/**
* @param connectionAttempts The number of times that CloudFront attempts to connect to the
* origin;.
* valid values are 1, 2, or 3 attempts.
*/
override fun connectionAttempts(connectionAttempts: Number) {
cdkBuilder.connectionAttempts(connectionAttempts)
}
/**
* @param connectionTimeout The number of seconds that CloudFront waits when trying to establish
* a connection to the origin.
* Valid values are 1-10 seconds, inclusive.
*/
override fun connectionTimeout(connectionTimeout: Duration) {
cdkBuilder.connectionTimeout(connectionTimeout.let(Duration.Companion::unwrap))
}
/**
* @param customHeaders A list of HTTP header names and values that CloudFront adds to requests
* it sends to the origin.
*/
override fun customHeaders(customHeaders: Map) {
cdkBuilder.customHeaders(customHeaders)
}
/**
* @param originAccessControl An optional Origin Access Control.
*/
override fun originAccessControl(originAccessControl: IOriginAccessControl) {
cdkBuilder.originAccessControl(originAccessControl.let(IOriginAccessControl.Companion::unwrap))
}
/**
* @param originAccessControlId The unique identifier of an origin access control for this
* origin.
*/
override fun originAccessControlId(originAccessControlId: String) {
cdkBuilder.originAccessControlId(originAccessControlId)
}
/**
* @param originAccessLevels The level of permissions granted in the bucket policy and key
* policy (if applicable) to the CloudFront distribution.
*/
override fun originAccessLevels(originAccessLevels: List) {
cdkBuilder.originAccessLevels(originAccessLevels.map(AccessLevel.Companion::unwrap))
}
/**
* @param originAccessLevels The level of permissions granted in the bucket policy and key
* policy (if applicable) to the CloudFront distribution.
*/
override fun originAccessLevels(vararg originAccessLevels: AccessLevel): Unit =
originAccessLevels(originAccessLevels.toList())
/**
* @param originId A unique identifier for the origin.
* This value must be unique within the distribution.
*/
override fun originId(originId: String) {
cdkBuilder.originId(originId)
}
/**
* @param originPath An optional path that CloudFront appends to the origin domain name when
* CloudFront requests content from the origin.
* Must begin, but not end, with '/' (e.g., '/production/images').
*/
override fun originPath(originPath: String) {
cdkBuilder.originPath(originPath)
}
/**
* @param originShieldEnabled Origin Shield is enabled by setting originShieldRegion to a valid
* region, after this to disable Origin Shield again you must set this flag to false.
*/
override fun originShieldEnabled(originShieldEnabled: Boolean) {
cdkBuilder.originShieldEnabled(originShieldEnabled)
}
/**
* @param originShieldRegion When you enable Origin Shield in the AWS Region that has the lowest
* latency to your origin, you can get better network performance.
*/
override fun originShieldRegion(originShieldRegion: String) {
cdkBuilder.originShieldRegion(originShieldRegion)
}
public fun build():
software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps,
) : CdkObject(cdkObject),
S3BucketOriginWithOACProps {
/**
* The number of times that CloudFront attempts to connect to the origin;
*
* valid values are 1, 2, or 3 attempts.
*
* Default: 3
*/
override fun connectionAttempts(): Number? = unwrap(this).getConnectionAttempts()
/**
* The number of seconds that CloudFront waits when trying to establish a connection to the
* origin.
*
* Valid values are 1-10 seconds, inclusive.
*
* Default: Duration.seconds(10)
*/
override fun connectionTimeout(): Duration? =
unwrap(this).getConnectionTimeout()?.let(Duration::wrap)
/**
* A list of HTTP header names and values that CloudFront adds to requests it sends to the
* origin.
*
* Default: {}
*/
override fun customHeaders(): Map = unwrap(this).getCustomHeaders() ?:
emptyMap()
/**
* An optional Origin Access Control.
*
* Default: - an Origin Access Control will be created.
*/
override fun originAccessControl(): IOriginAccessControl? =
unwrap(this).getOriginAccessControl()?.let(IOriginAccessControl::wrap)
/**
* The unique identifier of an origin access control for this origin.
*
* Default: - no origin access control
*/
override fun originAccessControlId(): String? = unwrap(this).getOriginAccessControlId()
/**
* The level of permissions granted in the bucket policy and key policy (if applicable) to the
* CloudFront distribution.
*
* Default: [AccessLevel.READ]
*/
override fun originAccessLevels(): List =
unwrap(this).getOriginAccessLevels()?.map(AccessLevel::wrap) ?: emptyList()
/**
* A unique identifier for the origin.
*
* This value must be unique within the distribution.
*
* Default: - an originid will be generated for you
*/
override fun originId(): String? = unwrap(this).getOriginId()
/**
* An optional path that CloudFront appends to the origin domain name when CloudFront requests
* content from the origin.
*
* Must begin, but not end, with '/' (e.g., '/production/images').
*
* Default: '/'
*/
override fun originPath(): String? = unwrap(this).getOriginPath()
/**
* Origin Shield is enabled by setting originShieldRegion to a valid region, after this to
* disable Origin Shield again you must set this flag to false.
*
* Default: - true
*/
override fun originShieldEnabled(): Boolean? = unwrap(this).getOriginShieldEnabled()
/**
* When you enable Origin Shield in the AWS Region that has the lowest latency to your origin,
* you can get better network performance.
*
* Default: - origin shield not enabled
*
* [Documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html)
*/
override fun originShieldRegion(): String? = unwrap(this).getOriginShieldRegion()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): S3BucketOriginWithOACProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps):
S3BucketOriginWithOACProps = CdkObjectWrappers.wrap(cdkObject) as?
S3BucketOriginWithOACProps ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: S3BucketOriginWithOACProps):
software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps = (wrapped as
CdkObject).cdkObject as
software.amazon.awscdk.services.cloudfront.origins.S3BucketOriginWithOACProps
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy