Package-level declarations

Types

Link copied to clipboard
class Container : KotlinCustomResource
Link copied to clipboard
data class ContainerArgs(val attach: Output<Boolean>? = null, val capabilities: Output<ContainerCapabilitiesArgs>? = null, val command: Output<List<String>>? = null, val containerReadRefreshTimeoutMilliseconds: Output<Int>? = null, val cpuSet: Output<String>? = null, val cpuShares: Output<Int>? = null, val destroyGraceSeconds: Output<Int>? = null, val devices: Output<List<ContainerDeviceArgs>>? = null, val dns: Output<List<String>>? = null, val dnsOpts: Output<List<String>>? = null, val dnsSearches: Output<List<String>>? = null, val domainname: Output<String>? = null, val entrypoints: Output<List<String>>? = null, val envs: Output<List<String>>? = null, val gpus: Output<String>? = null, val groupAdds: Output<List<String>>? = null, val healthcheck: Output<ContainerHealthcheckArgs>? = null, val hostname: Output<String>? = null, val hosts: Output<List<ContainerHostArgs>>? = null, val image: Output<String>? = null, val init: Output<Boolean>? = null, val ipcMode: Output<String>? = null, val labels: Output<List<ContainerLabelArgs>>? = null, val links: Output<List<String>>? = null, val logDriver: Output<String>? = null, val logOpts: Output<Map<String, Any>>? = null, val logs: Output<Boolean>? = null, val maxRetryCount: Output<Int>? = null, val memory: Output<Int>? = null, val memorySwap: Output<Int>? = null, val mounts: Output<List<ContainerMountArgs>>? = null, val mustRun: Output<Boolean>? = null, val name: Output<String>? = null, val networkAliases: Output<List<String>>? = null, val networkMode: Output<String>? = null, val networks: Output<List<String>>? = null, val networksAdvanced: Output<List<ContainerNetworksAdvancedArgs>>? = null, val pidMode: Output<String>? = null, val ports: Output<List<ContainerPortArgs>>? = null, val privileged: Output<Boolean>? = null, val publishAllPorts: Output<Boolean>? = null, val readOnly: Output<Boolean>? = null, val removeVolumes: Output<Boolean>? = null, val restart: Output<String>? = null, val rm: Output<Boolean>? = null, val runtime: Output<String>? = null, val securityOpts: Output<List<String>>? = null, val shmSize: Output<Int>? = null, val start: Output<Boolean>? = null, val stdinOpen: Output<Boolean>? = null, val stopSignal: Output<String>? = null, val stopTimeout: Output<Int>? = null, val storageOpts: Output<Map<String, Any>>? = null, val sysctls: Output<Map<String, Any>>? = null, val tmpfs: Output<Map<String, Any>>? = null, val tty: Output<Boolean>? = null, val ulimits: Output<List<ContainerUlimitArgs>>? = null, val uploads: Output<List<ContainerUploadArgs>>? = null, val user: Output<String>? = null, val usernsMode: Output<String>? = null, val volumes: Output<List<ContainerVolumeArgs>>? = null, val wait: Output<Boolean>? = null, val waitTimeout: Output<Int>? = null, val workingDir: Output<String>? = null) : ConvertibleToJava<ContainerArgs>
Link copied to clipboard
Link copied to clipboard
object ContainerMapper : ResourceMapper<Container>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class DockerProvider : KotlinProviderResource

The provider type for the docker package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
object DockerProviderMapper : ResourceMapper<DockerProvider>
Link copied to clipboard
class Network : KotlinCustomResource
Link copied to clipboard
data class NetworkArgs(val attachable: Output<Boolean>? = null, val checkDuplicate: Output<Boolean>? = null, val driver: Output<String>? = null, val ingress: Output<Boolean>? = null, val internal: Output<Boolean>? = null, val ipamConfigs: Output<List<NetworkIpamConfigArgs>>? = null, val ipamDriver: Output<String>? = null, val ipv6: Output<Boolean>? = null, val labels: Output<List<NetworkLabelArgs>>? = null, val name: Output<String>? = null, val options: Output<Map<String, Any>>? = null) : ConvertibleToJava<NetworkArgs>
Link copied to clipboard
Link copied to clipboard
object NetworkMapper : ResourceMapper<Network>
Link copied to clipboard
Link copied to clipboard
class Plugin : KotlinCustomResource
Link copied to clipboard
data class PluginArgs(val alias: Output<String>? = null, val enableTimeout: Output<Int>? = null, val enabled: Output<Boolean>? = null, val envs: Output<List<String>>? = null, val forceDestroy: Output<Boolean>? = null, val forceDisable: Output<Boolean>? = null, val grantAllPermissions: Output<Boolean>? = null, val grantPermissions: Output<List<PluginGrantPermissionArgs>>? = null, val name: Output<String>? = null) : ConvertibleToJava<PluginArgs>
Link copied to clipboard

Builder for PluginArgs.

Link copied to clipboard
object PluginMapper : ResourceMapper<Plugin>
Link copied to clipboard

Builder for Plugin.

Link copied to clipboard
data class ProviderArgs(val caMaterial: Output<String>? = null, val certMaterial: Output<String>? = null, val certPath: Output<String>? = null, val host: Output<String>? = null, val keyMaterial: Output<String>? = null, val registryAuth: Output<List<ProviderRegistryAuthArgs>>? = null, val sshOpts: Output<List<String>>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the docker package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
Link copied to clipboard
class RegistryImage : KotlinCustomResource
Link copied to clipboard
data class RegistryImageArgs(val build: Output<RegistryImageBuildArgs>? = null, val insecureSkipVerify: Output<Boolean>? = null, val keepRemotely: Output<Boolean>? = null, val name: Output<String>? = null) : ConvertibleToJava<RegistryImageArgs>
Link copied to clipboard
Link copied to clipboard
object RegistryImageMapper : ResourceMapper<RegistryImage>
Link copied to clipboard
Link copied to clipboard
class RemoteImage : KotlinCustomResource
Link copied to clipboard
data class RemoteImageArgs(val build: Output<RemoteImageBuildArgs>? = null, val forceRemove: Output<Boolean>? = null, val keepLocally: Output<Boolean>? = null, val name: Output<String>? = null, val pullTrigger: Output<String>? = null, val pullTriggers: Output<List<String>>? = null, val triggers: Output<Map<String, Any>>? = null) : ConvertibleToJava<RemoteImageArgs>
Link copied to clipboard
Link copied to clipboard
object RemoteImageMapper : ResourceMapper<RemoteImage>
Link copied to clipboard
Link copied to clipboard
class Secret : KotlinCustomResource

#!/bin/bash Docker secret cannot be imported as the secret data, once set, is never exposed again.

Link copied to clipboard
data class SecretArgs(val data: Output<String>? = null, val labels: Output<List<SecretLabelArgs>>? = null, val name: Output<String>? = null) : ConvertibleToJava<SecretArgs>

#!/bin/bash Docker secret cannot be imported as the secret data, once set, is never exposed again.

Link copied to clipboard

Builder for SecretArgs.

Link copied to clipboard
object SecretMapper : ResourceMapper<Secret>
Link copied to clipboard

Builder for Secret.

Link copied to clipboard
class Service : KotlinCustomResource

name = "foo" task_spec { container_spec { image = "nginx" } } endpoint_spec { ports { target_port = "80" published_port = "8080" } } } then the import command is as follows #!/bin/bash

Link copied to clipboard
data class ServiceArgs(val auth: Output<ServiceAuthArgs>? = null, val convergeConfig: Output<ServiceConvergeConfigArgs>? = null, val endpointSpec: Output<ServiceEndpointSpecArgs>? = null, val labels: Output<List<ServiceLabelArgs>>? = null, val mode: Output<ServiceModeArgs>? = null, val name: Output<String>? = null, val rollbackConfig: Output<ServiceRollbackConfigArgs>? = null, val taskSpec: Output<ServiceTaskSpecArgs>? = null, val updateConfig: Output<ServiceUpdateConfigArgs>? = null) : ConvertibleToJava<ServiceArgs>

name = "foo" task_spec { container_spec { image = "nginx" } } endpoint_spec { ports { target_port = "80" published_port = "8080" } } } then the import command is as follows #!/bin/bash

Link copied to clipboard
Link copied to clipboard
class ServiceConfig : KotlinCustomResource

08c26c477474478d971139f750984775a7f019dbe8a2e7f09d66a187c009e66d you provide the definition for the resource as follows terraform resource "docker_config" "foo" { name = "foo" data = base64encode("{\"a\"\"b\"}") } then the import command is as follows #!/bin/bash

Link copied to clipboard
data class ServiceConfigArgs(val data: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<ServiceConfigArgs>

08c26c477474478d971139f750984775a7f019dbe8a2e7f09d66a187c009e66d you provide the definition for the resource as follows terraform resource "docker_config" "foo" { name = "foo" data = base64encode("{\"a\"\"b\"}") } then the import command is as follows #!/bin/bash

Link copied to clipboard
Link copied to clipboard
object ServiceConfigMapper : ResourceMapper<ServiceConfig>
Link copied to clipboard
Link copied to clipboard
object ServiceMapper : ResourceMapper<Service>
Link copied to clipboard
Link copied to clipboard
class Tag : KotlinCustomResource

Creates a docker tag. It has the exact same functionality as the docker tag command. Deleting the resource will neither delete the source nor target images. The source image must exist on the machine running the docker daemon.

Link copied to clipboard
data class TagArgs(val sourceImage: Output<String>? = null, val targetImage: Output<String>? = null) : ConvertibleToJava<TagArgs>

Creates a docker tag. It has the exact same functionality as the docker tag command. Deleting the resource will neither delete the source nor target images. The source image must exist on the machine running the docker daemon.

Link copied to clipboard

Builder for TagArgs.

Link copied to clipboard
object TagMapper : ResourceMapper<Tag>
Link copied to clipboard

Builder for Tag.

Link copied to clipboard
class Volume : KotlinCustomResource
Link copied to clipboard
data class VolumeArgs(val driver: Output<String>? = null, val driverOpts: Output<Map<String, Any>>? = null, val labels: Output<List<VolumeLabelArgs>>? = null, val name: Output<String>? = null) : ConvertibleToJava<VolumeArgs>
Link copied to clipboard

Builder for VolumeArgs.

Link copied to clipboard
object VolumeMapper : ResourceMapper<Volume>
Link copied to clipboard

Builder for Volume.

Functions

Link copied to clipboard
suspend fun container(name: String, block: suspend ContainerResourceBuilder.() -> Unit): Container
Link copied to clipboard
Link copied to clipboard
fun network(name: String): Network
suspend fun network(name: String, block: suspend NetworkResourceBuilder.() -> Unit): Network
Link copied to clipboard
fun plugin(name: String): Plugin
suspend fun plugin(name: String, block: suspend PluginResourceBuilder.() -> Unit): Plugin
Link copied to clipboard
Link copied to clipboard
suspend fun remoteImage(name: String, block: suspend RemoteImageResourceBuilder.() -> Unit): RemoteImage
Link copied to clipboard
fun secret(name: String): Secret
suspend fun secret(name: String, block: suspend SecretResourceBuilder.() -> Unit): Secret
Link copied to clipboard
fun service(name: String): Service
suspend fun service(name: String, block: suspend ServiceResourceBuilder.() -> Unit): Service
Link copied to clipboard
Link copied to clipboard
fun tag(name: String): Tag
suspend fun tag(name: String, block: suspend TagResourceBuilder.() -> Unit): Tag
Link copied to clipboard
fun volume(name: String): Volume
suspend fun volume(name: String, block: suspend VolumeResourceBuilder.() -> Unit): Volume