Skip to content

Latest commit

 

History

History
671 lines (416 loc) · 25.2 KB

provider.java.md

File metadata and controls

671 lines (416 loc) · 25.2 KB

provider Submodule

Constructs

TfeProvider

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

Initializers 

import com.hashicorp.cdktf.providers.tfe.provider.TfeProvider;

TfeProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .hostname(java.lang.String)
//  .organization(java.lang.String)
//  .sslSkipVerify(java.lang.Boolean)
//  .sslSkipVerify(IResolvable)
//  .token(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
alias java.lang.String Alias name.
hostname java.lang.String The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.
organization java.lang.String The organization to apply to a resource if one is not defined on the resource itself.
sslSkipVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not to skip certificate verifications.
token java.lang.String The token used to authenticate with Terraform Enterprise.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#alias TfeProvider#alias}

hostnameOptional
  • Type: java.lang.String

The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#hostname TfeProvider#hostname}

organizationOptional
  • Type: java.lang.String

The organization to apply to a resource if one is not defined on the resource itself.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#organization TfeProvider#organization}

sslSkipVerifyOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not to skip certificate verifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#ssl_skip_verify TfeProvider#ssl_skip_verify}

tokenOptional
  • Type: java.lang.String

The token used to authenticate with Terraform Enterprise.

We recommend omitting the token which can be set as credentials in the CLI config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#token TfeProvider#token}

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.
resetHostname No description.
resetOrganization No description.
resetSslSkipVerify No description.
resetToken No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

resetAlias 
public void resetAlias()
resetHostname 
public void resetHostname()
resetOrganization 
public void resetOrganization()
resetSslSkipVerify 
public void resetSslSkipVerify()
resetToken 
public void resetToken()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a TfeProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.tfe.provider.TfeProvider;

TfeProvider.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.tfe.provider.TfeProvider;

TfeProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.tfe.provider.TfeProvider;

TfeProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.tfe.provider.TfeProvider;

TfeProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TfeProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing TfeProvider that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
aliasInput java.lang.String No description.
hostnameInput java.lang.String No description.
organizationInput java.lang.String No description.
sslSkipVerifyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tokenInput java.lang.String No description.
hostname java.lang.String No description.
organization java.lang.String No description.
sslSkipVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
token java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
hostnameInputOptional 
public java.lang.String getHostnameInput();
  • Type: java.lang.String
organizationInputOptional 
public java.lang.String getOrganizationInput();
  • Type: java.lang.String
sslSkipVerifyInputOptional 
public java.lang.Object getSslSkipVerifyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
hostnameOptional 
public java.lang.String getHostname();
  • Type: java.lang.String
organizationOptional 
public java.lang.String getOrganization();
  • Type: java.lang.String
sslSkipVerifyOptional 
public java.lang.Object getSslSkipVerify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

TfeProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.tfe.provider.TfeProviderConfig;

TfeProviderConfig.builder()
//  .alias(java.lang.String)
//  .hostname(java.lang.String)
//  .organization(java.lang.String)
//  .sslSkipVerify(java.lang.Boolean)
//  .sslSkipVerify(IResolvable)
//  .token(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
hostname java.lang.String The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.
organization java.lang.String The organization to apply to a resource if one is not defined on the resource itself.
sslSkipVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not to skip certificate verifications.
token java.lang.String The token used to authenticate with Terraform Enterprise.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#alias TfeProvider#alias}

hostnameOptional 
public java.lang.String getHostname();
  • Type: java.lang.String

The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#hostname TfeProvider#hostname}

organizationOptional 
public java.lang.String getOrganization();
  • Type: java.lang.String

The organization to apply to a resource if one is not defined on the resource itself.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#organization TfeProvider#organization}

sslSkipVerifyOptional 
public java.lang.Object getSslSkipVerify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not to skip certificate verifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#ssl_skip_verify TfeProvider#ssl_skip_verify}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

The token used to authenticate with Terraform Enterprise.

We recommend omitting the token which can be set as credentials in the CLI config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs#token TfeProvider#token}