provider

README

provider

Refer to the Terraform Registory for docs: nomad.

Documentation

Index

• func NewNomadProvider_Override(n NomadProvider, scope constructs.Construct, id *string, ...)
• func NomadProvider_IsConstruct(x interface{}) *bool
• func NomadProvider_IsTerraformElement(x interface{}) *bool
• func NomadProvider_IsTerraformProvider(x interface{}) *bool
• func NomadProvider_TfResourceType() *string
• type NomadProvider
  • func NewNomadProvider(scope constructs.Construct, id *string, config *NomadProviderConfig) NomadProvider
• type NomadProviderConfig
• type NomadProviderHeaders

Functions

func NewNomadProvider_Override

func NewNomadProvider_Override(n NomadProvider, scope constructs.Construct, id *string, config *NomadProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/nomad nomad} Resource.

func NomadProvider_IsConstruct

func NomadProvider_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 NomadProvider_IsTerraformElement

func NomadProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func NomadProvider_IsTerraformProvider

func NomadProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func NomadProvider_TfResourceType

func NomadProvider_TfResourceType() *string

Types

type NomadProvider

type NomadProvider interface {
	cdktf.TerraformProvider
	Address() *string
	SetAddress(val *string)
	AddressInput() *string
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	CaFile() *string
	SetCaFile(val *string)
	CaFileInput() *string
	CaPem() *string
	SetCaPem(val *string)
	CaPemInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CertFile() *string
	SetCertFile(val *string)
	CertFileInput() *string
	CertPem() *string
	SetCertPem(val *string)
	CertPemInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	ConsulToken() *string
	SetConsulToken(val *string)
	ConsulTokenInput() *string
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Headers() interface{}
	SetHeaders(val interface{})
	HeadersInput() interface{}
	HttpAuth() *string
	SetHttpAuth(val *string)
	HttpAuthInput() *string
	IgnoreEnvVars() *map[string]interface{}
	SetIgnoreEnvVars(val *map[string]interface{})
	IgnoreEnvVarsInput() *map[string]interface{}
	KeyFile() *string
	SetKeyFile(val *string)
	KeyFileInput() *string
	KeyPem() *string
	SetKeyPem(val *string)
	KeyPemInput() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	Region() *string
	SetRegion(val *string)
	RegionInput() *string
	SecretId() *string
	SetSecretId(val *string)
	SecretIdInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	VaultToken() *string
	SetVaultToken(val *string)
	VaultTokenInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetCaFile()
	ResetCaPem()
	ResetCertFile()
	ResetCertPem()
	ResetConsulToken()
	ResetHeaders()
	ResetHttpAuth()
	ResetIgnoreEnvVars()
	ResetKeyFile()
	ResetKeyPem()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRegion()
	ResetSecretId()
	ResetVaultToken()
	SynthesizeAttributes() *map[string]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://www.terraform.io/docs/providers/nomad nomad}.

func NewNomadProvider

func NewNomadProvider(scope constructs.Construct, id *string, config *NomadProviderConfig) NomadProvider

Create a new {@link https://www.terraform.io/docs/providers/nomad nomad} Resource.

type NomadProviderConfig

type NomadProviderConfig struct {
	// URL of the root of the target Nomad agent.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#address NomadProvider#address}
	Address *string `field:"required" json:"address" yaml:"address"`
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#alias NomadProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#ca_file NomadProvider#ca_file}
	CaFile *string `field:"optional" json:"caFile" yaml:"caFile"`
	// PEM-encoded certificate authority used to verify the remote agent's certificate.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#ca_pem NomadProvider#ca_pem}
	CaPem *string `field:"optional" json:"caPem" yaml:"caPem"`
	// A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#cert_file NomadProvider#cert_file}
	CertFile *string `field:"optional" json:"certFile" yaml:"certFile"`
	// PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#cert_pem NomadProvider#cert_pem}
	CertPem *string `field:"optional" json:"certPem" yaml:"certPem"`
	// Consul token to validate Consul Connect Service Identity policies specified in the job file.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#consul_token NomadProvider#consul_token}
	ConsulToken *string `field:"optional" json:"consulToken" yaml:"consulToken"`
	// headers block.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#headers NomadProvider#headers}
	Headers interface{} `field:"optional" json:"headers" yaml:"headers"`
	// HTTP basic auth configuration.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#http_auth NomadProvider#http_auth}
	HttpAuth *string `field:"optional" json:"httpAuth" yaml:"httpAuth"`
	// A set of environment variables that are ignored by the provider when configuring the Nomad API client.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#ignore_env_vars NomadProvider#ignore_env_vars}
	IgnoreEnvVars *map[string]interface{} `field:"optional" json:"ignoreEnvVars" yaml:"ignoreEnvVars"`
	// A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#key_file NomadProvider#key_file}
	KeyFile *string `field:"optional" json:"keyFile" yaml:"keyFile"`
	// PEM-encoded private key, required if cert_file or cert_pem is specified.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#key_pem NomadProvider#key_pem}
	KeyPem *string `field:"optional" json:"keyPem" yaml:"keyPem"`
	// Region of the target Nomad agent.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#region NomadProvider#region}
	Region *string `field:"optional" json:"region" yaml:"region"`
	// ACL token secret for API requests.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#secret_id NomadProvider#secret_id}
	SecretId *string `field:"optional" json:"secretId" yaml:"secretId"`
	// Vault token if policies are specified in the job file.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#vault_token NomadProvider#vault_token}
	VaultToken *string `field:"optional" json:"vaultToken" yaml:"vaultToken"`
}

type NomadProviderHeaders

type NomadProviderHeaders struct {
	// The header name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#name NomadProvider#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The header value.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/nomad#value NomadProvider#value}
	Value *string `field:"required" json:"value" yaml:"value"`
}