Skip to content

Latest commit

 

History

History
1589 lines (991 loc) · 58.6 KB

plugin.go.md

File metadata and controls

1589 lines (991 loc) · 58.6 KB

docker_plugin

Refer to the Terraform Registory for docs: docker_plugin.

plugin Submodule

Constructs

Plugin

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

Initializers 

import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.NewPlugin(scope Construct, id *string, config PluginConfig) Plugin
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config PluginConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
PutGrantPermissions No description.
ResetAlias No description.
ResetEnabled No description.
ResetEnableTimeout No description.
ResetEnv No description.
ResetForceDestroy No description.
ResetForceDisable No description.
ResetGrantAllPermissions No description.
ResetGrantPermissions No description.
ResetId No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
PutGrantPermissions 
func PutGrantPermissions(value interface{})
valueRequired
  • Type: interface{}
ResetAlias 
func ResetAlias()
ResetEnabled 
func ResetEnabled()
ResetEnableTimeout 
func ResetEnableTimeout()
ResetEnv 
func ResetEnv()
ResetForceDestroy 
func ResetForceDestroy()
ResetForceDisable 
func ResetForceDisable()
ResetGrantAllPermissions 
func ResetGrantAllPermissions()
ResetGrantPermissions 
func ResetGrantPermissions()
ResetId 
func ResetId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
IsConstruct 
import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.Plugin_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.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.Plugin_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.Plugin_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
GrantPermissions PluginGrantPermissionsList No description.
PluginReference *string No description.
AliasInput *string No description.
EnabledInput interface{} No description.
EnableTimeoutInput *f64 No description.
EnvInput *[]*string No description.
ForceDestroyInput interface{} No description.
ForceDisableInput interface{} No description.
GrantAllPermissionsInput interface{} No description.
GrantPermissionsInput interface{} No description.
IdInput *string No description.
NameInput *string No description.
Alias *string No description.
Enabled interface{} No description.
EnableTimeout *f64 No description.
Env *[]*string No description.
ForceDestroy interface{} No description.
ForceDisable interface{} No description.
GrantAllPermissions interface{} No description.
Id *string No description.
Name *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
GrantPermissionsRequired 
func GrantPermissions() PluginGrantPermissionsList
PluginReferenceRequired 
func PluginReference() *string
  • Type: *string
AliasInputOptional 
func AliasInput() *string
  • Type: *string
EnabledInputOptional 
func EnabledInput() interface{}
  • Type: interface{}
EnableTimeoutInputOptional 
func EnableTimeoutInput() *f64
  • Type: *f64
EnvInputOptional 
func EnvInput() *[]*string
  • Type: *[]*string
ForceDestroyInputOptional 
func ForceDestroyInput() interface{}
  • Type: interface{}
ForceDisableInputOptional 
func ForceDisableInput() interface{}
  • Type: interface{}
GrantAllPermissionsInputOptional 
func GrantAllPermissionsInput() interface{}
  • Type: interface{}
GrantPermissionsInputOptional 
func GrantPermissionsInput() interface{}
  • Type: interface{}
IdInputOptional 
func IdInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
AliasRequired 
func Alias() *string
  • Type: *string
EnabledRequired 
func Enabled() interface{}
  • Type: interface{}
EnableTimeoutRequired 
func EnableTimeout() *f64
  • Type: *f64
EnvRequired 
func Env() *[]*string
  • Type: *[]*string
ForceDestroyRequired 
func ForceDestroy() interface{}
  • Type: interface{}
ForceDisableRequired 
func ForceDisable() interface{}
  • Type: interface{}
GrantAllPermissionsRequired 
func GrantAllPermissions() interface{}
  • Type: interface{}
IdRequired 
func Id() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

PluginConfig

Initializer 

import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

&plugin.PluginConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Name: *string,
	Alias: *string,
	Enabled: interface{},
	EnableTimeout: *f64,
	Env: *[]*string,
	ForceDestroy: interface{},
	ForceDisable: interface{},
	GrantAllPermissions: interface{},
	GrantPermissions: interface{},
	Id: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Name *string Docker Plugin name.
Alias *string Docker Plugin alias.
Enabled interface{} If true the plugin is enabled. Defaults to true.
EnableTimeout *f64 HTTP client timeout to enable the plugin.
Env *[]*string The environment variables in the form of KEY=VALUE, e.g. DEBUG=0.
ForceDestroy interface{} If true, then the plugin is destroyed forcibly.
ForceDisable interface{} If true, then the plugin is disabled forcibly.
GrantAllPermissions interface{} If true, grant all permissions necessary to run the plugin.
GrantPermissions interface{} grant_permissions block.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#id Plugin#id}.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
NameRequired 
Name *string
  • Type: *string

Docker Plugin name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#name Plugin#name}

AliasOptional 
Alias *string
  • Type: *string

Docker Plugin alias.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#alias Plugin#alias}

EnabledOptional 
Enabled interface{}
  • Type: interface{}

If true the plugin is enabled. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#enabled Plugin#enabled}

EnableTimeoutOptional 
EnableTimeout *f64
  • Type: *f64

HTTP client timeout to enable the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#enable_timeout Plugin#enable_timeout}

EnvOptional 
Env *[]*string
  • Type: *[]*string

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#env Plugin#env}

ForceDestroyOptional 
ForceDestroy interface{}
  • Type: interface{}

If true, then the plugin is destroyed forcibly.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#force_destroy Plugin#force_destroy}

ForceDisableOptional 
ForceDisable interface{}
  • Type: interface{}

If true, then the plugin is disabled forcibly.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#force_disable Plugin#force_disable}

GrantAllPermissionsOptional 
GrantAllPermissions interface{}
  • Type: interface{}

If true, grant all permissions necessary to run the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#grant_all_permissions Plugin#grant_all_permissions}

GrantPermissionsOptional 
GrantPermissions interface{}
  • Type: interface{}

grant_permissions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#grant_permissions Plugin#grant_permissions}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#id Plugin#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

PluginGrantPermissions

Initializer 

import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

&plugin.PluginGrantPermissions {
	Name: *string,
	Value: *[]*string,
}

Properties

Name Type Description
Name *string The name of the permission.
Value *[]*string The value of the permission.
NameRequired 
Name *string
  • Type: *string

The name of the permission.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#name Plugin#name}

ValueRequired 
Value *[]*string
  • Type: *[]*string

The value of the permission.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs/resources/plugin#value Plugin#value}

Classes

PluginGrantPermissionsList

Initializers 

import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.NewPluginGrantPermissionsList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) PluginGrantPermissionsList
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
wrapsSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
func Get(index *f64) PluginGrantPermissionsOutputReference
indexRequired
  • Type: *f64

the index of the item to return.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

PluginGrantPermissionsOutputReference

Initializers 

import "github.com/cdktf/cdktf-provider-docker-go/docker/v7/plugin"

plugin.NewPluginGrantPermissionsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) PluginGrantPermissionsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
complexObjectIndex *f64 the index of this item in the list.
complexObjectIsFromSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ComputeFqn 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
NameInput *string No description.
ValueInput *[]*string No description.
Name *string No description.
Value *[]*string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
ValueInputOptional 
func ValueInput() *[]*string
  • Type: *[]*string
NameRequired 
func Name() *string
  • Type: *string
ValueRequired 
func Value() *[]*string
  • Type: *[]*string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}