Skip to content

Latest commit

 

History

History
605 lines (373 loc) · 24.3 KB

provider.typescript.md

File metadata and controls

605 lines (373 loc) · 24.3 KB
Raw

provider Submodule

Constructs

LaunchdarklyProvider

Represents a {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs launchdarkly}.

Initializers 

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

new provider.LaunchdarklyProvider(scope: Construct, id: string, config?: LaunchdarklyProviderConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config LaunchdarklyProviderConfig 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

configOptional

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.
resetAccessToken No description.
resetAlias No description.
resetApiHost No description.
resetHttpTimeout No description.
resetOauthToken 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.

resetAccessToken 
public resetAccessToken(): void
resetAlias 
public resetAlias(): void
resetApiHost 
public resetApiHost(): void
resetHttpTimeout 
public resetHttpTimeout(): void
resetOauthToken 
public resetOauthToken(): 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 LaunchdarklyProvider resource upon running "cdktf plan ".
isConstruct 
import { provider } from '@cdktf/provider-launchdarkly'

provider.LaunchdarklyProvider.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-launchdarkly'

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

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

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

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

importFromIdRequired
  • Type: string

The id of the existing LaunchdarklyProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/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 LaunchdarklyProvider 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.
accessTokenInput string No description.
aliasInput string No description.
apiHostInput string No description.
httpTimeoutInput number No description.
oauthTokenInput string No description.
accessToken string No description.
apiHost string No description.
httpTimeout number No description.
oauthToken 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
accessTokenInputOptional 
public readonly accessTokenInput: string;
  • Type: string
aliasInputOptional 
public readonly aliasInput: string;
  • Type: string
apiHostInputOptional 
public readonly apiHostInput: string;
  • Type: string
httpTimeoutInputOptional 
public readonly httpTimeoutInput: number;
  • Type: number
oauthTokenInputOptional 
public readonly oauthTokenInput: string;
  • Type: string
accessTokenOptional 
public readonly accessToken: string;
  • Type: string
apiHostOptional 
public readonly apiHost: string;
  • Type: string
httpTimeoutOptional 
public readonly httpTimeout: number;
  • Type: number
oauthTokenOptional 
public readonly oauthToken: string;
  • Type: string

Constants

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

Structs

LaunchdarklyProviderConfig

Initializer 

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

const launchdarklyProviderConfig: provider.LaunchdarklyProviderConfig = { ... }

Properties

Name Type Description
accessToken string The personal access token or service token used to authenticate with LaunchDarkly. You can also set this with the LAUNCHDARKLY_ACCESS_TOKEN environment variable. You must provide either access_token or oauth_token.
alias string Alias name.
apiHost string The LaunchDarkly host address. If this argument is not specified, the default host address is https://app.launchdarkly.com.
httpTimeout number The HTTP timeout (in seconds) when making API calls to LaunchDarkly.
oauthToken string An OAuth V2 token you use to authenticate with LaunchDarkly.
accessTokenOptional 
public readonly accessToken: string;
  • Type: string

The personal access token or service token used to authenticate with LaunchDarkly. You can also set this with the LAUNCHDARKLY_ACCESS_TOKEN environment variable. You must provide either access_token or oauth_token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs#access_token LaunchdarklyProvider#access_token}

aliasOptional 
public readonly alias: string;
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs#alias LaunchdarklyProvider#alias}

apiHostOptional 
public readonly apiHost: string;
  • Type: string

The LaunchDarkly host address. If this argument is not specified, the default host address is https://app.launchdarkly.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs#api_host LaunchdarklyProvider#api_host}

httpTimeoutOptional 
public readonly httpTimeout: number;
  • Type: number

The HTTP timeout (in seconds) when making API calls to LaunchDarkly.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs#http_timeout LaunchdarklyProvider#http_timeout}

oauthTokenOptional 
public readonly oauthToken: string;
  • Type: string

An OAuth V2 token you use to authenticate with LaunchDarkly.

You can also set this with the LAUNCHDARKLY_OAUTH_TOKEN environment variable. You must provide either access_token or oauth_token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs#oauth_token LaunchdarklyProvider#oauth_token}