provider

README

provider

Refer to the Terraform Registry for docs: docker.

Documentation

Index

• func DockerProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DockerProvider_IsConstruct(x interface{}) *bool
• func DockerProvider_IsTerraformElement(x interface{}) *bool
• func DockerProvider_IsTerraformProvider(x interface{}) *bool
• func DockerProvider_TfResourceType() *string
• func NewDockerProvider_Override(d DockerProvider, scope constructs.Construct, id *string, ...)
• type DockerProvider
  • func NewDockerProvider(scope constructs.Construct, id *string, config *DockerProviderConfig) DockerProvider
• type DockerProviderConfig
• type DockerProviderRegistryAuth

Functions

func DockerProvider_GenerateConfigForImport

func DockerProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DockerProvider resource upon running "cdktf plan <stack-name>".

func DockerProvider_IsConstruct

func DockerProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DockerProvider_IsTerraformElement

func DockerProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func DockerProvider_IsTerraformProvider

func DockerProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func DockerProvider_TfResourceType

func DockerProvider_TfResourceType() *string

func NewDockerProvider_Override

func NewDockerProvider_Override(d DockerProvider, scope constructs.Construct, id *string, config *DockerProviderConfig)

Create a new {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs docker} Resource.

Types

type DockerProvider

type DockerProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	CaMaterial() *string
	SetCaMaterial(val *string)
	CaMaterialInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CertMaterial() *string
	SetCertMaterial(val *string)
	CertMaterialInput() *string
	CertPath() *string
	SetCertPath(val *string)
	CertPathInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Host() *string
	SetHost(val *string)
	HostInput() *string
	KeyMaterial() *string
	SetKeyMaterial(val *string)
	KeyMaterialInput() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	RegistryAuth() interface{}
	SetRegistryAuth(val interface{})
	RegistryAuthInput() interface{}
	SshOpts() *[]*string
	SetSshOpts(val *[]*string)
	SshOptsInput() *[]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetCaMaterial()
	ResetCertMaterial()
	ResetCertPath()
	ResetHost()
	ResetKeyMaterial()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRegistryAuth()
	ResetSshOpts()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs docker}.

func NewDockerProvider

func NewDockerProvider(scope constructs.Construct, id *string, config *DockerProviderConfig) DockerProvider

Create a new {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs docker} Resource.

type DockerProviderConfig

type DockerProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#alias DockerProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// PEM-encoded content of Docker host CA certificate.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#ca_material DockerProvider#ca_material}
	CaMaterial *string `field:"optional" json:"caMaterial" yaml:"caMaterial"`
	// PEM-encoded content of Docker client certificate.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#cert_material DockerProvider#cert_material}
	CertMaterial *string `field:"optional" json:"certMaterial" yaml:"certMaterial"`
	// Path to directory with Docker TLS config.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#cert_path DockerProvider#cert_path}
	CertPath *string `field:"optional" json:"certPath" yaml:"certPath"`
	// The Docker daemon address.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#host DockerProvider#host}
	Host *string `field:"optional" json:"host" yaml:"host"`
	// PEM-encoded content of Docker client private key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#key_material DockerProvider#key_material}
	KeyMaterial *string `field:"optional" json:"keyMaterial" yaml:"keyMaterial"`
	// registry_auth block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#registry_auth DockerProvider#registry_auth}
	RegistryAuth interface{} `field:"optional" json:"registryAuth" yaml:"registryAuth"`
	// Additional SSH option flags to be appended when using `ssh://` protocol.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#ssh_opts DockerProvider#ssh_opts}
	SshOpts *[]*string `field:"optional" json:"sshOpts" yaml:"sshOpts"`
}

type DockerProviderRegistryAuth

type DockerProviderRegistryAuth struct {
	// Address of the registry.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#address DockerProvider#address}
	Address *string `field:"required" json:"address" yaml:"address"`
	// Setting this to `true` will tell the provider that this registry does not need authentication.
	//
	// Due to the docker internals, the provider will use dummy credentials (see https://github.com/kreuzwerker/terraform-provider-docker/issues/470 for more information). Defaults to `false`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#auth_disabled DockerProvider#auth_disabled}
	AuthDisabled interface{} `field:"optional" json:"authDisabled" yaml:"authDisabled"`
	// Path to docker json file for registry auth.
	//
	// Defaults to `~/.docker/config.json`. If `DOCKER_CONFIG` is set, the value of `DOCKER_CONFIG` is used as the path. `config_file` has predencen over all other options.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#config_file DockerProvider#config_file}
	ConfigFile *string `field:"optional" json:"configFile" yaml:"configFile"`
	// Plain content of the docker json file for registry auth. `config_file_content` has precedence over username/password.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#config_file_content DockerProvider#config_file_content}
	ConfigFileContent *string `field:"optional" json:"configFileContent" yaml:"configFileContent"`
	// Password for the registry. Defaults to `DOCKER_REGISTRY_PASS` env variable if set.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#password DockerProvider#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Username for the registry. Defaults to `DOCKER_REGISTRY_USER` env variable if set.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs#username DockerProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}