io.cloudshiftdev.awscdk.AssetOptions.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.String
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Asset hash options.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.*;
* DockerImage dockerImage;
* ILocalBundling localBundling;
* AssetOptions assetOptions = AssetOptions.builder()
* .assetHash("assetHash")
* .assetHashType(AssetHashType.SOURCE)
* .bundling(BundlingOptions.builder()
* .image(dockerImage)
* // the properties below are optional
* .bundlingFileAccess(BundlingFileAccess.VOLUME_COPY)
* .command(List.of("command"))
* .entrypoint(List.of("entrypoint"))
* .environment(Map.of(
* "environmentKey", "environment"))
* .local(localBundling)
* .network("network")
* .outputType(BundlingOutput.ARCHIVED)
* .platform("platform")
* .securityOpt("securityOpt")
* .user("user")
* .volumes(List.of(DockerVolume.builder()
* .containerPath("containerPath")
* .hostPath("hostPath")
* // the properties below are optional
* .consistency(DockerVolumeConsistency.CONSISTENT)
* .build()))
* .volumesFrom(List.of("volumesFrom"))
* .workingDirectory("workingDirectory")
* .build())
* .build();
* ```
*/
public interface AssetOptions {
/**
* Specify a custom hash for this asset.
*
* If `assetHashType` is set it must
* be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
* be SHA256 hashed and encoded as hex. The resulting hash will be the asset
* hash.
*
* NOTE: the hash is used in order to identify a specific revision of the asset, and
* used for optimizing and caching deployment activities related to this asset such as
* packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
* need to make sure it is updated every time the asset changes, or otherwise it is
* possible that some deployments will not be invalidated.
*
* Default: - based on `assetHashType`
*/
public fun assetHash(): String? = unwrap(this).getAssetHash()
/**
* Specifies the type of hash to calculate for this asset.
*
* If `assetHash` is configured, this option must be `undefined` or
* `AssetHashType.CUSTOM`.
*
* Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is
* explicitly specified this value defaults to `AssetHashType.CUSTOM`.
*/
public fun assetHashType(): AssetHashType? =
unwrap(this).getAssetHashType()?.let(AssetHashType::wrap)
/**
* Bundle the asset by executing a command in a Docker container or a custom bundling provider.
*
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*
* Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file,
* archived into a .zip file and uploaded to S3 otherwise
*/
public fun bundling(): BundlingOptions? = unwrap(this).getBundling()?.let(BundlingOptions::wrap)
/**
* A builder for [AssetOptions]
*/
@CdkDslMarker
public interface Builder {
/**
* @param assetHash Specify a custom hash for this asset.
* If `assetHashType` is set it must
* be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
* be SHA256 hashed and encoded as hex. The resulting hash will be the asset
* hash.
*
* NOTE: the hash is used in order to identify a specific revision of the asset, and
* used for optimizing and caching deployment activities related to this asset such as
* packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
* need to make sure it is updated every time the asset changes, or otherwise it is
* possible that some deployments will not be invalidated.
*/
public fun assetHash(assetHash: String)
/**
* @param assetHashType Specifies the type of hash to calculate for this asset.
* If `assetHash` is configured, this option must be `undefined` or
* `AssetHashType.CUSTOM`.
*/
public fun assetHashType(assetHashType: AssetHashType)
/**
* @param bundling Bundle the asset by executing a command in a Docker container or a custom
* bundling provider.
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*/
public fun bundling(bundling: BundlingOptions)
/**
* @param bundling Bundle the asset by executing a command in a Docker container or a custom
* bundling provider.
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ab28d33e994f3bcf578da232f9f18828c83bb8c71639a3c730b57fb713dade02")
public fun bundling(bundling: BundlingOptions.Builder.() -> Unit)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.AssetOptions.Builder =
software.amazon.awscdk.AssetOptions.builder()
/**
* @param assetHash Specify a custom hash for this asset.
* If `assetHashType` is set it must
* be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
* be SHA256 hashed and encoded as hex. The resulting hash will be the asset
* hash.
*
* NOTE: the hash is used in order to identify a specific revision of the asset, and
* used for optimizing and caching deployment activities related to this asset such as
* packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
* need to make sure it is updated every time the asset changes, or otherwise it is
* possible that some deployments will not be invalidated.
*/
override fun assetHash(assetHash: String) {
cdkBuilder.assetHash(assetHash)
}
/**
* @param assetHashType Specifies the type of hash to calculate for this asset.
* If `assetHash` is configured, this option must be `undefined` or
* `AssetHashType.CUSTOM`.
*/
override fun assetHashType(assetHashType: AssetHashType) {
cdkBuilder.assetHashType(assetHashType.let(AssetHashType.Companion::unwrap))
}
/**
* @param bundling Bundle the asset by executing a command in a Docker container or a custom
* bundling provider.
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*/
override fun bundling(bundling: BundlingOptions) {
cdkBuilder.bundling(bundling.let(BundlingOptions.Companion::unwrap))
}
/**
* @param bundling Bundle the asset by executing a command in a Docker container or a custom
* bundling provider.
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ab28d33e994f3bcf578da232f9f18828c83bb8c71639a3c730b57fb713dade02")
override fun bundling(bundling: BundlingOptions.Builder.() -> Unit): Unit =
bundling(BundlingOptions(bundling))
public fun build(): software.amazon.awscdk.AssetOptions = cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.AssetOptions,
) : CdkObject(cdkObject),
AssetOptions {
/**
* Specify a custom hash for this asset.
*
* If `assetHashType` is set it must
* be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
* be SHA256 hashed and encoded as hex. The resulting hash will be the asset
* hash.
*
* NOTE: the hash is used in order to identify a specific revision of the asset, and
* used for optimizing and caching deployment activities related to this asset such as
* packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
* need to make sure it is updated every time the asset changes, or otherwise it is
* possible that some deployments will not be invalidated.
*
* Default: - based on `assetHashType`
*/
override fun assetHash(): String? = unwrap(this).getAssetHash()
/**
* Specifies the type of hash to calculate for this asset.
*
* If `assetHash` is configured, this option must be `undefined` or
* `AssetHashType.CUSTOM`.
*
* Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is
* explicitly specified this value defaults to `AssetHashType.CUSTOM`.
*/
override fun assetHashType(): AssetHashType? =
unwrap(this).getAssetHashType()?.let(AssetHashType::wrap)
/**
* Bundle the asset by executing a command in a Docker container or a custom bundling provider.
*
* The asset path will be mounted at `/asset-input`. The Docker
* container is responsible for putting content at `/asset-output`.
* The content at `/asset-output` will be zipped and used as the
* final asset.
*
* Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file,
* archived into a .zip file and uploaded to S3 otherwise
*/
override fun bundling(): BundlingOptions? =
unwrap(this).getBundling()?.let(BundlingOptions::wrap)
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): AssetOptions {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.AssetOptions): AssetOptions =
CdkObjectWrappers.wrap(cdkObject) as? AssetOptions ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: AssetOptions): software.amazon.awscdk.AssetOptions = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.AssetOptions
}
}