Skip to content

Latest commit

 

History

History
908 lines (565 loc) · 36.3 KB

provider.typescript.md

File metadata and controls

908 lines (565 loc) · 36.3 KB
Raw

provider Submodule

Constructs

BoundaryProvider

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

Initializers 

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

new provider.BoundaryProvider(scope: Construct, id: string, config: BoundaryProviderConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config BoundaryProviderConfig 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.
resetAuthMethodId No description.
resetAuthMethodLoginName No description.
resetAuthMethodPassword No description.
resetPasswordAuthMethodLoginName No description.
resetPasswordAuthMethodPassword No description.
resetPluginExecutionDir No description.
resetRecoveryKmsHcl No description.
resetScopeId No description.
resetTlsInsecure No description.
resetToken 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
resetAuthMethodId 
public resetAuthMethodId(): void
resetAuthMethodLoginName 
public resetAuthMethodLoginName(): void
resetAuthMethodPassword 
public resetAuthMethodPassword(): void
resetPasswordAuthMethodLoginName 
public resetPasswordAuthMethodLoginName(): void
resetPasswordAuthMethodPassword 
public resetPasswordAuthMethodPassword(): void
resetPluginExecutionDir 
public resetPluginExecutionDir(): void
resetRecoveryKmsHcl 
public resetRecoveryKmsHcl(): void
resetScopeId 
public resetScopeId(): void
resetTlsInsecure 
public resetTlsInsecure(): void
resetToken 
public resetToken(): 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 BoundaryProvider resource upon running "cdktf plan ".
isConstruct 
import { provider } from '@cdktf/provider-boundary'

provider.BoundaryProvider.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-boundary'

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

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

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

Generates CDKTF code for importing a BoundaryProvider 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 BoundaryProvider to import.

importFromIdRequired
  • Type: string

The id of the existing BoundaryProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.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 BoundaryProvider 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.
addrInput string No description.
aliasInput string No description.
authMethodIdInput string No description.
authMethodLoginNameInput string No description.
authMethodPasswordInput string No description.
passwordAuthMethodLoginNameInput string No description.
passwordAuthMethodPasswordInput string No description.
pluginExecutionDirInput string No description.
recoveryKmsHclInput string No description.
scopeIdInput string No description.
tlsInsecureInput boolean | cdktf.IResolvable No description.
tokenInput string No description.
addr string No description.
authMethodId string No description.
authMethodLoginName string No description.
authMethodPassword string No description.
passwordAuthMethodLoginName string No description.
passwordAuthMethodPassword string No description.
pluginExecutionDir string No description.
recoveryKmsHcl string No description.
scopeId string No description.
tlsInsecure boolean | cdktf.IResolvable No description.
token 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
addrInputOptional 
public readonly addrInput: string;
  • Type: string
aliasInputOptional 
public readonly aliasInput: string;
  • Type: string
authMethodIdInputOptional 
public readonly authMethodIdInput: string;
  • Type: string
authMethodLoginNameInputOptional 
public readonly authMethodLoginNameInput: string;
  • Type: string
authMethodPasswordInputOptional 
public readonly authMethodPasswordInput: string;
  • Type: string
passwordAuthMethodLoginNameInputOptional 
public readonly passwordAuthMethodLoginNameInput: string;
  • Type: string
passwordAuthMethodPasswordInputOptional 
public readonly passwordAuthMethodPasswordInput: string;
  • Type: string
pluginExecutionDirInputOptional 
public readonly pluginExecutionDirInput: string;
  • Type: string
recoveryKmsHclInputOptional 
public readonly recoveryKmsHclInput: string;
  • Type: string
scopeIdInputOptional 
public readonly scopeIdInput: string;
  • Type: string
tlsInsecureInputOptional 
public readonly tlsInsecureInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tokenInputOptional 
public readonly tokenInput: string;
  • Type: string
addrOptional 
public readonly addr: string;
  • Type: string
authMethodIdOptional 
public readonly authMethodId: string;
  • Type: string
authMethodLoginNameOptional 
public readonly authMethodLoginName: string;
  • Type: string
authMethodPasswordOptional 
public readonly authMethodPassword: string;
  • Type: string
passwordAuthMethodLoginNameOptional 
public readonly passwordAuthMethodLoginName: string;
  • Type: string
passwordAuthMethodPasswordOptional 
public readonly passwordAuthMethodPassword: string;
  • Type: string
pluginExecutionDirOptional 
public readonly pluginExecutionDir: string;
  • Type: string
recoveryKmsHclOptional 
public readonly recoveryKmsHcl: string;
  • Type: string
scopeIdOptional 
public readonly scopeId: string;
  • Type: string
tlsInsecureOptional 
public readonly tlsInsecure: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tokenOptional 
public readonly token: string;
  • Type: string

Constants

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

Structs

BoundaryProviderConfig

Initializer 

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

const boundaryProviderConfig: provider.BoundaryProviderConfig = { ... }

Properties

Name Type Description
addr string The base url of the Boundary API, e.g. "http://127.0.0.1:9200". If not set, it will be read from the "BOUNDARY_ADDR" env var.
alias string Alias name.
authMethodId string The auth method ID e.g. ampw_1234567890. If not set, the default auth method for the given scope ID will be used.
authMethodLoginName string The auth method login name for password-style or ldap-style auth methods.
authMethodPassword string The auth method password for password-style or ldap-style auth methods.
passwordAuthMethodLoginName string The auth method login name for password-style auth methods.
passwordAuthMethodPassword string The auth method password for password-style auth methods.
pluginExecutionDir string Specifies a directory that the Boundary provider can use to write and execute its built-in plugins.
recoveryKmsHcl string Can be a heredoc string or a path on disk.
scopeId string The scope ID for the default auth method.
tlsInsecure boolean | cdktf.IResolvable When set to true, does not validate the Boundary API endpoint certificate.
token string The Boundary token to use, as a string or path on disk containing just the string.
addrRequired 
public readonly addr: string;
  • Type: string

The base url of the Boundary API, e.g. "http://127.0.0.1:9200". If not set, it will be read from the "BOUNDARY_ADDR" env var.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#addr BoundaryProvider#addr}

aliasOptional 
public readonly alias: string;
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#alias BoundaryProvider#alias}

authMethodIdOptional 
public readonly authMethodId: string;
  • Type: string

The auth method ID e.g. ampw_1234567890. If not set, the default auth method for the given scope ID will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#auth_method_id BoundaryProvider#auth_method_id}

authMethodLoginNameOptional 
public readonly authMethodLoginName: string;
  • Type: string

The auth method login name for password-style or ldap-style auth methods.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#auth_method_login_name BoundaryProvider#auth_method_login_name}

authMethodPasswordOptional 
public readonly authMethodPassword: string;
  • Type: string

The auth method password for password-style or ldap-style auth methods.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#auth_method_password BoundaryProvider#auth_method_password}

passwordAuthMethodLoginNameOptional 
public readonly passwordAuthMethodLoginName: string;
  • Type: string

The auth method login name for password-style auth methods.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#password_auth_method_login_name BoundaryProvider#password_auth_method_login_name}

passwordAuthMethodPasswordOptional 
public readonly passwordAuthMethodPassword: string;
  • Type: string

The auth method password for password-style auth methods.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#password_auth_method_password BoundaryProvider#password_auth_method_password}

pluginExecutionDirOptional 
public readonly pluginExecutionDir: string;
  • Type: string

Specifies a directory that the Boundary provider can use to write and execute its built-in plugins.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#plugin_execution_dir BoundaryProvider#plugin_execution_dir}

recoveryKmsHclOptional 
public readonly recoveryKmsHcl: string;
  • Type: string

Can be a heredoc string or a path on disk.

If set, the string/file will be parsed as HCL and used with the recovery KMS mechanism. While this is set, it will override any other authentication information; the KMS mechanism will always be used. See Boundary's KMS docs for examples: https://boundaryproject.io/docs/configuration/kms

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#recovery_kms_hcl BoundaryProvider#recovery_kms_hcl}

scopeIdOptional 
public readonly scopeId: string;
  • Type: string

The scope ID for the default auth method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#scope_id BoundaryProvider#scope_id}

tlsInsecureOptional 
public readonly tlsInsecure: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

When set to true, does not validate the Boundary API endpoint certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#tls_insecure BoundaryProvider#tls_insecure}

tokenOptional 
public readonly token: string;
  • Type: string

The Boundary token to use, as a string or path on disk containing just the string.

If set, the token read here will be used in place of authenticating with the auth method specified in "auth_method_id", although the recovery KMS mechanism will still override this. Can also be set with the BOUNDARY_TOKEN environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs#token BoundaryProvider#token}