Skip to content

Latest commit

 

History

History
1705 lines (1061 loc) · 74.2 KB

dataTfeWorkspace.java.md

File metadata and controls

1705 lines (1061 loc) · 74.2 KB

dataTfeWorkspace Submodule

Constructs

DataTfeWorkspace

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace tfe_workspace}.

Initializers

import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspace;

DataTfeWorkspace.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .organization(java.lang.String)
//  .tagNames(java.util.List<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.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#name DataTfeWorkspace#name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.
tagNames java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.

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


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#name DataTfeWorkspace#name}.


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


organizationOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.


tagNamesOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.


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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resetId No description.
resetOrganization No description.
resetTagNames 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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

resetId
public void resetId()
resetOrganization
public void resetOrganization()
resetTagNames
public void resetTagNames()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataTfeWorkspace resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspace;

DataTfeWorkspace.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.data_tfe_workspace.DataTfeWorkspace;

DataTfeWorkspace.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformDataSource
import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspace;

DataTfeWorkspace.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspace;

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

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing DataTfeWorkspace that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#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 DataTfeWorkspace 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.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
allowDestroyPlan com.hashicorp.cdktf.IResolvable No description.
assessmentsEnabled com.hashicorp.cdktf.IResolvable No description.
autoApply com.hashicorp.cdktf.IResolvable No description.
autoApplyRunTrigger com.hashicorp.cdktf.IResolvable No description.
description java.lang.String No description.
executionMode java.lang.String No description.
fileTriggersEnabled com.hashicorp.cdktf.IResolvable No description.
globalRemoteState com.hashicorp.cdktf.IResolvable No description.
htmlUrl java.lang.String No description.
operations com.hashicorp.cdktf.IResolvable No description.
policyCheckFailures java.lang.Number No description.
projectId java.lang.String No description.
queueAllRuns com.hashicorp.cdktf.IResolvable No description.
remoteStateConsumerIds java.util.List<java.lang.String> No description.
resourceCount java.lang.Number No description.
runFailures java.lang.Number No description.
runsCount java.lang.Number No description.
sourceName java.lang.String No description.
sourceUrl java.lang.String No description.
speculativeEnabled com.hashicorp.cdktf.IResolvable No description.
sshKeyId java.lang.String No description.
structuredRunOutputEnabled com.hashicorp.cdktf.IResolvable No description.
terraformVersion java.lang.String No description.
triggerPatterns java.util.List<java.lang.String> No description.
triggerPrefixes java.util.List<java.lang.String> No description.
vcsRepo DataTfeWorkspaceVcsRepoList No description.
workingDirectory java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
organizationInput java.lang.String No description.
tagNamesInput java.util.List<java.lang.String> No description.
id java.lang.String No description.
name java.lang.String No description.
organization java.lang.String No description.
tagNames java.util.List<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

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • 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

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

allowDestroyPlanRequired
public IResolvable getAllowDestroyPlan();
  • Type: com.hashicorp.cdktf.IResolvable

assessmentsEnabledRequired
public IResolvable getAssessmentsEnabled();
  • Type: com.hashicorp.cdktf.IResolvable

autoApplyRequired
public IResolvable getAutoApply();
  • Type: com.hashicorp.cdktf.IResolvable

autoApplyRunTriggerRequired
public IResolvable getAutoApplyRunTrigger();
  • Type: com.hashicorp.cdktf.IResolvable

descriptionRequired
public java.lang.String getDescription();
  • Type: java.lang.String

executionModeRequired
public java.lang.String getExecutionMode();
  • Type: java.lang.String

fileTriggersEnabledRequired
public IResolvable getFileTriggersEnabled();
  • Type: com.hashicorp.cdktf.IResolvable

globalRemoteStateRequired
public IResolvable getGlobalRemoteState();
  • Type: com.hashicorp.cdktf.IResolvable

htmlUrlRequired
public java.lang.String getHtmlUrl();
  • Type: java.lang.String

operationsRequired
public IResolvable getOperations();
  • Type: com.hashicorp.cdktf.IResolvable

policyCheckFailuresRequired
public java.lang.Number getPolicyCheckFailures();
  • Type: java.lang.Number

projectIdRequired
public java.lang.String getProjectId();
  • Type: java.lang.String

queueAllRunsRequired
public IResolvable getQueueAllRuns();
  • Type: com.hashicorp.cdktf.IResolvable

remoteStateConsumerIdsRequired
public java.util.List<java.lang.String> getRemoteStateConsumerIds();
  • Type: java.util.List<java.lang.String>

resourceCountRequired
public java.lang.Number getResourceCount();
  • Type: java.lang.Number

runFailuresRequired
public java.lang.Number getRunFailures();
  • Type: java.lang.Number

runsCountRequired
public java.lang.Number getRunsCount();
  • Type: java.lang.Number

sourceNameRequired
public java.lang.String getSourceName();
  • Type: java.lang.String

sourceUrlRequired
public java.lang.String getSourceUrl();
  • Type: java.lang.String

speculativeEnabledRequired
public IResolvable getSpeculativeEnabled();
  • Type: com.hashicorp.cdktf.IResolvable

sshKeyIdRequired
public java.lang.String getSshKeyId();
  • Type: java.lang.String

structuredRunOutputEnabledRequired
public IResolvable getStructuredRunOutputEnabled();
  • Type: com.hashicorp.cdktf.IResolvable

terraformVersionRequired
public java.lang.String getTerraformVersion();
  • Type: java.lang.String

triggerPatternsRequired
public java.util.List<java.lang.String> getTriggerPatterns();
  • Type: java.util.List<java.lang.String>

triggerPrefixesRequired
public java.util.List<java.lang.String> getTriggerPrefixes();
  • Type: java.util.List<java.lang.String>

vcsRepoRequired
public DataTfeWorkspaceVcsRepoList getVcsRepo();

workingDirectoryRequired
public java.lang.String getWorkingDirectory();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

organizationInputOptional
public java.lang.String getOrganizationInput();
  • Type: java.lang.String

tagNamesInputOptional
public java.util.List<java.lang.String> getTagNamesInput();
  • Type: java.util.List<java.lang.String>

idRequired
public java.lang.String getId();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

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

tagNamesRequired
public java.util.List<java.lang.String> getTagNames();
  • Type: java.util.List<java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DataTfeWorkspaceConfig

Initializer

import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspaceConfig;

DataTfeWorkspaceConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .organization(java.lang.String)
//  .tagNames(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#name DataTfeWorkspace#name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.
tagNames java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#name DataTfeWorkspace#name}.


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#id DataTfeWorkspace#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#organization DataTfeWorkspace#organization}.


tagNamesOptional
public java.util.List<java.lang.String> getTagNames();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/data-sources/workspace#tag_names DataTfeWorkspace#tag_names}.


DataTfeWorkspaceVcsRepo

Initializer

import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspaceVcsRepo;

DataTfeWorkspaceVcsRepo.builder()
    .build();

Classes

DataTfeWorkspaceVcsRepoList

Initializers

import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspaceVcsRepoList;

new DataTfeWorkspaceVcsRepoList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String

computeFqn
public java.lang.String computeFqn()
resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public DataTfeWorkspaceVcsRepoOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.


Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

DataTfeWorkspaceVcsRepoOutputReference

Initializers

import com.hashicorp.cdktf.providers.tfe.data_tfe_workspace.DataTfeWorkspaceVcsRepoOutputReference;

new DataTfeWorkspaceVcsRepoOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
branch java.lang.String No description.
githubAppInstallationId java.lang.String No description.
identifier java.lang.String No description.
ingressSubmodules com.hashicorp.cdktf.IResolvable No description.
oauthTokenId java.lang.String No description.
tagsRegex java.lang.String No description.
internalValue DataTfeWorkspaceVcsRepo No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

branchRequired
public java.lang.String getBranch();
  • Type: java.lang.String

githubAppInstallationIdRequired
public java.lang.String getGithubAppInstallationId();
  • Type: java.lang.String

identifierRequired
public java.lang.String getIdentifier();
  • Type: java.lang.String

ingressSubmodulesRequired
public IResolvable getIngressSubmodules();
  • Type: com.hashicorp.cdktf.IResolvable

oauthTokenIdRequired
public java.lang.String getOauthTokenId();
  • Type: java.lang.String

tagsRegexRequired
public java.lang.String getTagsRegex();
  • Type: java.lang.String

internalValueOptional
public DataTfeWorkspaceVcsRepo getInternalValue();