Skip to content

Latest commit

 

History

History
1127 lines (703 loc) · 41.4 KB

provider.typescript.md

File metadata and controls

1127 lines (703 loc) · 41.4 KB
Raw

provider Submodule

Constructs

NomadProvider

Represents a {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs nomad}.

Initializers 

import { provider } from '@cdktf/provider-nomad'

new provider.NomadProvider(scope: Construct, id: string, config: NomadProviderConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config NomadProviderConfig No description.
scopeRequired
  • Type: constructs.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.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
resetAlias No description.
resetCaFile No description.
resetCaPem No description.
resetCertFile No description.
resetCertPem No description.
resetConsulToken No description.
resetHeaders No description.
resetHttpAuth No description.
resetIgnoreEnvVars No description.
resetKeyFile No description.
resetKeyPem No description.
resetRegion No description.
resetSecretId No description.
resetSkipVerify No description.
resetVaultToken No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

resetAlias 
public resetAlias(): void
resetCaFile 
public resetCaFile(): void
resetCaPem 
public resetCaPem(): void
resetCertFile 
public resetCertFile(): void
resetCertPem 
public resetCertPem(): void
resetConsulToken 
public resetConsulToken(): void
resetHeaders 
public resetHeaders(): void
resetHttpAuth 
public resetHttpAuth(): void
resetIgnoreEnvVars 
public resetIgnoreEnvVars(): void
resetKeyFile 
public resetKeyFile(): void
resetKeyPem 
public resetKeyPem(): void
resetRegion 
public resetRegion(): void
resetSecretId 
public resetSecretId(): void
resetSkipVerify 
public resetSkipVerify(): void
resetVaultToken 
public resetVaultToken(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a NomadProvider resource upon running "cdktf plan ".
isConstruct 
import { provider } from '@cdktf/provider-nomad'

provider.NomadProvider.isConstruct(x: any)

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: any

Any object.

isTerraformElement 
import { provider } from '@cdktf/provider-nomad'

provider.NomadProvider.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformProvider 
import { provider } from '@cdktf/provider-nomad'

provider.NomadProvider.isTerraformProvider(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { provider } from '@cdktf/provider-nomad'

provider.NomadProvider.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a NomadProvider resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the NomadProvider to import.

importFromIdRequired
  • Type: string

The id of the existing NomadProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the NomadProvider to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
metaAttributes {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource string No description.
alias string No description.
addressInput string No description.
aliasInput string No description.
caFileInput string No description.
caPemInput string No description.
certFileInput string No description.
certPemInput string No description.
consulTokenInput string No description.
headersInput cdktf.IResolvable | NomadProviderHeaders[] No description.
httpAuthInput string No description.
ignoreEnvVarsInput {[ key: string ]: boolean | cdktf.IResolvable} No description.
keyFileInput string No description.
keyPemInput string No description.
regionInput string No description.
secretIdInput string No description.
skipVerifyInput boolean | cdktf.IResolvable No description.
vaultTokenInput string No description.
address string No description.
caFile string No description.
caPem string No description.
certFile string No description.
certPem string No description.
consulToken string No description.
headers cdktf.IResolvable | NomadProviderHeaders[] No description.
httpAuth string No description.
ignoreEnvVars {[ key: string ]: boolean | cdktf.IResolvable} No description.
keyFile string No description.
keyPem string No description.
region string No description.
secretId string No description.
skipVerify boolean | cdktf.IResolvable No description.
vaultToken string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
metaAttributesRequired 
public readonly metaAttributes: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public readonly terraformProviderSource: string;
  • Type: string
aliasOptional 
public readonly alias: string;
  • Type: string
addressInputOptional 
public readonly addressInput: string;
  • Type: string
aliasInputOptional 
public readonly aliasInput: string;
  • Type: string
caFileInputOptional 
public readonly caFileInput: string;
  • Type: string
caPemInputOptional 
public readonly caPemInput: string;
  • Type: string
certFileInputOptional 
public readonly certFileInput: string;
  • Type: string
certPemInputOptional 
public readonly certPemInput: string;
  • Type: string
consulTokenInputOptional 
public readonly consulTokenInput: string;
  • Type: string
headersInputOptional 
public readonly headersInput: IResolvable | NomadProviderHeaders[];
httpAuthInputOptional 
public readonly httpAuthInput: string;
  • Type: string
ignoreEnvVarsInputOptional 
public readonly ignoreEnvVarsInput: {[ key: string ]: boolean | IResolvable};
  • Type: {[ key: string ]: boolean | cdktf.IResolvable}
keyFileInputOptional 
public readonly keyFileInput: string;
  • Type: string
keyPemInputOptional 
public readonly keyPemInput: string;
  • Type: string
regionInputOptional 
public readonly regionInput: string;
  • Type: string
secretIdInputOptional 
public readonly secretIdInput: string;
  • Type: string
skipVerifyInputOptional 
public readonly skipVerifyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
vaultTokenInputOptional 
public readonly vaultTokenInput: string;
  • Type: string
addressOptional 
public readonly address: string;
  • Type: string
caFileOptional 
public readonly caFile: string;
  • Type: string
caPemOptional 
public readonly caPem: string;
  • Type: string
certFileOptional 
public readonly certFile: string;
  • Type: string
certPemOptional 
public readonly certPem: string;
  • Type: string
consulTokenOptional 
public readonly consulToken: string;
  • Type: string
headersOptional 
public readonly headers: IResolvable | NomadProviderHeaders[];
httpAuthOptional 
public readonly httpAuth: string;
  • Type: string
ignoreEnvVarsOptional 
public readonly ignoreEnvVars: {[ key: string ]: boolean | IResolvable};
  • Type: {[ key: string ]: boolean | cdktf.IResolvable}
keyFileOptional 
public readonly keyFile: string;
  • Type: string
keyPemOptional 
public readonly keyPem: string;
  • Type: string
regionOptional 
public readonly region: string;
  • Type: string
secretIdOptional 
public readonly secretId: string;
  • Type: string
skipVerifyOptional 
public readonly skipVerify: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
vaultTokenOptional 
public readonly vaultToken: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

NomadProviderConfig

Initializer 

import { provider } from '@cdktf/provider-nomad'

const nomadProviderConfig: provider.NomadProviderConfig = { ... }

Properties

Name Type Description
address string URL of the root of the target Nomad agent.
alias string Alias name.
caFile string A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
caPem string PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile string A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
certPem string PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.
consulToken string Consul token to validate Consul Connect Service Identity policies specified in the job file.
headers cdktf.IResolvable | NomadProviderHeaders[] headers block.
httpAuth string HTTP basic auth configuration.
ignoreEnvVars {[ key: string ]: boolean | cdktf.IResolvable} A set of environment variables that are ignored by the provider when configuring the Nomad API client.
keyFile string A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.
keyPem string PEM-encoded private key, required if cert_file or cert_pem is specified.
region string Region of the target Nomad agent.
secretId string ACL token secret for API requests.
skipVerify boolean | cdktf.IResolvable Skip TLS verification on client side.
vaultToken string Vault token if policies are specified in the job file.
addressRequired 
public readonly address: string;
  • Type: string

URL of the root of the target Nomad agent.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#address NomadProvider#address}

aliasOptional 
public readonly alias: string;
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#alias NomadProvider#alias}

caFileOptional 
public readonly caFile: string;
  • Type: string

A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#ca_file NomadProvider#ca_file}

caPemOptional 
public readonly caPem: string;
  • Type: string

PEM-encoded certificate authority used to verify the remote agent's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#ca_pem NomadProvider#ca_pem}

certFileOptional 
public readonly certFile: string;
  • Type: string

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://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#cert_file NomadProvider#cert_file}

certPemOptional 
public readonly certPem: string;
  • Type: string

PEM-encoded certificate provided to the remote agent; requires use of key_file or key_pem.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#cert_pem NomadProvider#cert_pem}

consulTokenOptional 
public readonly consulToken: string;
  • Type: string

Consul token to validate Consul Connect Service Identity policies specified in the job file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#consul_token NomadProvider#consul_token}

headersOptional 
public readonly headers: IResolvable | NomadProviderHeaders[];

headers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#headers NomadProvider#headers}

httpAuthOptional 
public readonly httpAuth: string;
  • Type: string

HTTP basic auth configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#http_auth NomadProvider#http_auth}

ignoreEnvVarsOptional 
public readonly ignoreEnvVars: {[ key: string ]: boolean | IResolvable};
  • Type: {[ key: string ]: boolean | cdktf.IResolvable}

A set of environment variables that are ignored by the provider when configuring the Nomad API client.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#ignore_env_vars NomadProvider#ignore_env_vars}

keyFileOptional 
public readonly keyFile: string;
  • Type: string

A path to a PEM-encoded private key, required if cert_file or cert_pem is specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#key_file NomadProvider#key_file}

keyPemOptional 
public readonly keyPem: string;
  • Type: string

PEM-encoded private key, required if cert_file or cert_pem is specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#key_pem NomadProvider#key_pem}

regionOptional 
public readonly region: string;
  • Type: string

Region of the target Nomad agent.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#region NomadProvider#region}

secretIdOptional 
public readonly secretId: string;
  • Type: string

ACL token secret for API requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#secret_id NomadProvider#secret_id}

skipVerifyOptional 
public readonly skipVerify: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Skip TLS verification on client side.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#skip_verify NomadProvider#skip_verify}

vaultTokenOptional 
public readonly vaultToken: string;
  • Type: string

Vault token if policies are specified in the job file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#vault_token NomadProvider#vault_token}

NomadProviderHeaders

Initializer 

import { provider } from '@cdktf/provider-nomad'

const nomadProviderHeaders: provider.NomadProviderHeaders = { ... }

Properties

Name Type Description
name string The header name.
value string The header value.
nameRequired 
public readonly name: string;
  • Type: string

The header name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#name NomadProvider#name}

valueRequired 
public readonly value: string;
  • Type: string

The header value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs#value NomadProvider#value}