Skip to content

Latest commit

 

History

History
1963 lines (1226 loc) · 82.8 KB

project.java.md

File metadata and controls

1963 lines (1226 loc) · 82.8 KB
Raw

project Submodule

Constructs

Project

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project google_project}.

Initializers 

import com.hashicorp.cdktf.providers.google.project.Project;

Project.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)
    .projectId(java.lang.String)
//  .autoCreateNetwork(java.lang.Boolean)
//  .autoCreateNetwork(IResolvable)
//  .billingAccount(java.lang.String)
//  .deletionPolicy(java.lang.String)
//  .folderId(java.lang.String)
//  .id(java.lang.String)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .orgId(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(ProjectTimeouts)
    .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 The display name of the project.
projectId java.lang.String The project ID. Changing this forces a new project to be created.
autoCreateNetwork java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Create the 'default' network automatically.
billingAccount java.lang.String The alphanumeric ID of the billing account this project belongs to.
deletionPolicy java.lang.String The deletion policy for the Project.
folderId java.lang.String The numeric ID of the folder this project should be created under.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#id Project#id}.
labels java.util.Map<java.lang.String, java.lang.String> A set of key/value label pairs to assign to the project.
orgId java.lang.String The numeric ID of the organization this project belongs to.
tags java.util.Map<java.lang.String, java.lang.String> A map of resource manager tags.
timeouts ProjectTimeouts timeouts block.
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

The display name of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#name Project#name}

projectIdRequired
  • Type: java.lang.String

The project ID. Changing this forces a new project to be created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#project_id Project#project_id}

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

Create the 'default' network automatically.

Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#auto_create_network Project#auto_create_network}

billingAccountOptional
  • Type: java.lang.String

The alphanumeric ID of the billing account this project belongs to.

The user or service account performing this operation with Terraform must have Billing Account Administrator privileges (roles/billing.admin) in the organization. See Google Cloud Billing API Access Control for more details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#billing_account Project#billing_account}

deletionPolicyOptional
  • Type: java.lang.String

The deletion policy for the Project.

Setting PREVENT will protect the project against any destroy actions caused by a terraform apply or terraform destroy. Setting ABANDON allows the resource to be abandoned rather than deleted. Possible values are: "PREVENT", "ABANDON", "DELETE"

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#deletion_policy Project#deletion_policy}

folderIdOptional
  • Type: java.lang.String

The numeric ID of the folder this project should be created under.

Only one of org_id or folder_id may be specified. If the folder_id is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#folder_id Project#folder_id}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#id Project#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.

labelsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

A set of key/value label pairs to assign to the project.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#labels Project#labels}

orgIdOptional
  • Type: java.lang.String

The numeric ID of the organization this project belongs to.

Changing this forces a new project to be created. Only one of org_id or folder_id may be specified. If the org_id is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#org_id Project#org_id}

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

A map of resource manager tags.

Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. This field is only set at create time and modifying this field after creation will trigger recreation. To apply tags to an existing resource, see the google_tags_tag_value resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#tags Project#tags}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#timeouts Project#timeouts}

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.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetAutoCreateNetwork No description.
resetBillingAccount No description.
resetDeletionPolicy No description.
resetFolderId No description.
resetId No description.
resetLabels No description.
resetOrgId No description.
resetTags No description.
resetTimeouts 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.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

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
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putTimeouts 
public void putTimeouts(ProjectTimeouts value)
valueRequired
resetAutoCreateNetwork 
public void resetAutoCreateNetwork()
resetBillingAccount 
public void resetBillingAccount()
resetDeletionPolicy 
public void resetDeletionPolicy()
resetFolderId 
public void resetFolderId()
resetId 
public void resetId()
resetLabels 
public void resetLabels()
resetOrgId 
public void resetOrgId()
resetTags 
public void resetTags()
resetTimeouts 
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Project resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.google.project.Project;

Project.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.google.project.Project;

Project.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.google.project.Project;

Project.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.google.project.Project;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing Project that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#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 Project 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.
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<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.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
effectiveLabels com.hashicorp.cdktf.StringMap No description.
number java.lang.String No description.
terraformLabels com.hashicorp.cdktf.StringMap No description.
timeouts ProjectTimeoutsOutputReference No description.
autoCreateNetworkInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
billingAccountInput java.lang.String No description.
deletionPolicyInput java.lang.String No description.
folderIdInput java.lang.String No description.
idInput java.lang.String No description.
labelsInput java.util.Map<java.lang.String, java.lang.String> No description.
nameInput java.lang.String No description.
orgIdInput java.lang.String No description.
projectIdInput java.lang.String No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR ProjectTimeouts No description.
autoCreateNetwork java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
billingAccount java.lang.String No description.
deletionPolicy java.lang.String No description.
folderId java.lang.String No description.
id java.lang.String No description.
labels java.util.Map<java.lang.String, java.lang.String> No description.
name java.lang.String No description.
orgId java.lang.String No description.
projectId java.lang.String No description.
tags java.util.Map<java.lang.String, 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
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<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
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
effectiveLabelsRequired 
public StringMap getEffectiveLabels();
  • Type: com.hashicorp.cdktf.StringMap
numberRequired 
public java.lang.String getNumber();
  • Type: java.lang.String
terraformLabelsRequired 
public StringMap getTerraformLabels();
  • Type: com.hashicorp.cdktf.StringMap
timeoutsRequired 
public ProjectTimeoutsOutputReference getTimeouts();
autoCreateNetworkInputOptional 
public java.lang.Object getAutoCreateNetworkInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
billingAccountInputOptional 
public java.lang.String getBillingAccountInput();
  • Type: java.lang.String
deletionPolicyInputOptional 
public java.lang.String getDeletionPolicyInput();
  • Type: java.lang.String
folderIdInputOptional 
public java.lang.String getFolderIdInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
labelsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getLabelsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
orgIdInputOptional 
public java.lang.String getOrgIdInput();
  • Type: java.lang.String
projectIdInputOptional 
public java.lang.String getProjectIdInput();
  • Type: java.lang.String
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
autoCreateNetworkRequired 
public java.lang.Object getAutoCreateNetwork();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
billingAccountRequired 
public java.lang.String getBillingAccount();
  • Type: java.lang.String
deletionPolicyRequired 
public java.lang.String getDeletionPolicy();
  • Type: java.lang.String
folderIdRequired 
public java.lang.String getFolderId();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
labelsRequired 
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
orgIdRequired 
public java.lang.String getOrgId();
  • Type: java.lang.String
projectIdRequired 
public java.lang.String getProjectId();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

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

Structs

ProjectConfig

Initializer 

import com.hashicorp.cdktf.providers.google.project.ProjectConfig;

ProjectConfig.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)
    .projectId(java.lang.String)
//  .autoCreateNetwork(java.lang.Boolean)
//  .autoCreateNetwork(IResolvable)
//  .billingAccount(java.lang.String)
//  .deletionPolicy(java.lang.String)
//  .folderId(java.lang.String)
//  .id(java.lang.String)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .orgId(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(ProjectTimeouts)
    .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 The display name of the project.
projectId java.lang.String The project ID. Changing this forces a new project to be created.
autoCreateNetwork java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Create the 'default' network automatically.
billingAccount java.lang.String The alphanumeric ID of the billing account this project belongs to.
deletionPolicy java.lang.String The deletion policy for the Project.
folderId java.lang.String The numeric ID of the folder this project should be created under.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#id Project#id}.
labels java.util.Map<java.lang.String, java.lang.String> A set of key/value label pairs to assign to the project.
orgId java.lang.String The numeric ID of the organization this project belongs to.
tags java.util.Map<java.lang.String, java.lang.String> A map of resource manager tags.
timeouts ProjectTimeouts timeouts block.
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

The display name of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#name Project#name}

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

The project ID. Changing this forces a new project to be created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#project_id Project#project_id}

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

Create the 'default' network automatically.

Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#auto_create_network Project#auto_create_network}

billingAccountOptional 
public java.lang.String getBillingAccount();
  • Type: java.lang.String

The alphanumeric ID of the billing account this project belongs to.

The user or service account performing this operation with Terraform must have Billing Account Administrator privileges (roles/billing.admin) in the organization. See Google Cloud Billing API Access Control for more details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#billing_account Project#billing_account}

deletionPolicyOptional 
public java.lang.String getDeletionPolicy();
  • Type: java.lang.String

The deletion policy for the Project.

Setting PREVENT will protect the project against any destroy actions caused by a terraform apply or terraform destroy. Setting ABANDON allows the resource to be abandoned rather than deleted. Possible values are: "PREVENT", "ABANDON", "DELETE"

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#deletion_policy Project#deletion_policy}

folderIdOptional 
public java.lang.String getFolderId();
  • Type: java.lang.String

The numeric ID of the folder this project should be created under.

Only one of org_id or folder_id may be specified. If the folder_id is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#folder_id Project#folder_id}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#id Project#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.

labelsOptional 
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>

A set of key/value label pairs to assign to the project.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#labels Project#labels}

orgIdOptional 
public java.lang.String getOrgId();
  • Type: java.lang.String

The numeric ID of the organization this project belongs to.

Changing this forces a new project to be created. Only one of org_id or folder_id may be specified. If the org_id is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#org_id Project#org_id}

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

A map of resource manager tags.

Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. This field is only set at create time and modifying this field after creation will trigger recreation. To apply tags to an existing resource, see the google_tags_tag_value resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#tags Project#tags}

timeoutsOptional 
public ProjectTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#timeouts Project#timeouts}

ProjectTimeouts

Initializer 

import com.hashicorp.cdktf.providers.google.project.ProjectTimeouts;

ProjectTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .read(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#create Project#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#delete Project#delete}.
read java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#read Project#read}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#update Project#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#create Project#create}.

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#delete Project#delete}.

readOptional 
public java.lang.String getRead();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#read Project#read}.

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/project#update Project#update}.

Classes

ProjectTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google.project.ProjectTimeoutsOutputReference;

new ProjectTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

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.
resetCreate No description.
resetDelete No description.
resetRead No description.
resetUpdate No description.
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.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()
resetRead 
public void resetRead()
resetUpdate 
public void resetUpdate()

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.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
readInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
read java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR ProjectTimeouts 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
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
readInputOptional 
public java.lang.String getReadInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
readRequired 
public java.lang.String getRead();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();