Skip to content

Latest commit

 

History

History
2077 lines (1308 loc) · 90.2 KB

policySet.java.md

File metadata and controls

2077 lines (1308 loc) · 90.2 KB
Raw

policySet Submodule

Constructs

PolicySet

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set tfe_policy_set}.

Initializers 

import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySet;

PolicySet.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)
//  .agentEnabled(java.lang.Boolean)
//  .agentEnabled(IResolvable)
//  .description(java.lang.String)
//  .global(java.lang.Boolean)
//  .global(IResolvable)
//  .id(java.lang.String)
//  .kind(java.lang.String)
//  .organization(java.lang.String)
//  .overridable(java.lang.Boolean)
//  .overridable(IResolvable)
//  .policiesPath(java.lang.String)
//  .policyIds(java.util.List<java.lang.String>)
//  .policyToolVersion(java.lang.String)
//  .slug(java.util.Map<java.lang.String, java.lang.String>)
//  .vcsRepo(PolicySetVcsRepo)
//  .workspaceIds(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/resources/policy_set#name PolicySet#name}.
agentEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#description PolicySet#description}.
global java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#global PolicySet#global}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#id PolicySet#id}.
kind java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#kind PolicySet#kind}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#organization PolicySet#organization}.
overridable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#overridable PolicySet#overridable}.
policiesPath java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.
policyIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.
policyToolVersion java.lang.String The policy tool version to run the policy evaluation against.
slug java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#slug PolicySet#slug}.
vcsRepo PolicySetVcsRepo vcs_repo block.
workspaceIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#workspace_ids PolicySet#workspace_ids}.
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/resources/policy_set#name PolicySet#name}.

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

Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#agent_enabled PolicySet#agent_enabled}

descriptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#description PolicySet#description}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#global PolicySet#global}.

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#id PolicySet#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.

kindOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#kind PolicySet#kind}.

organizationOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#organization PolicySet#organization}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#overridable PolicySet#overridable}.

policiesPathOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.

policyToolVersionOptional
  • Type: java.lang.String

The policy tool version to run the policy evaluation against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_tool_version PolicySet#policy_tool_version}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#slug PolicySet#slug}.

vcsRepoOptional

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#vcs_repo PolicySet#vcs_repo}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#workspace_ids PolicySet#workspace_ids}.

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".
putVcsRepo No description.
resetAgentEnabled No description.
resetDescription No description.
resetGlobal No description.
resetId No description.
resetKind No description.
resetOrganization No description.
resetOverridable No description.
resetPoliciesPath No description.
resetPolicyIds No description.
resetPolicyToolVersion No description.
resetSlug No description.
resetVcsRepo No description.
resetWorkspaceIds 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".

putVcsRepo 
public void putVcsRepo(PolicySetVcsRepo value)
valueRequired
resetAgentEnabled 
public void resetAgentEnabled()
resetDescription 
public void resetDescription()
resetGlobal 
public void resetGlobal()
resetId 
public void resetId()
resetKind 
public void resetKind()
resetOrganization 
public void resetOrganization()
resetOverridable 
public void resetOverridable()
resetPoliciesPath 
public void resetPoliciesPath()
resetPolicyIds 
public void resetPolicyIds()
resetPolicyToolVersion 
public void resetPolicyToolVersion()
resetSlug 
public void resetSlug()
resetVcsRepo 
public void resetVcsRepo()
resetWorkspaceIds 
public void resetWorkspaceIds()

Static Functions

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

PolicySet.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.policy_set.PolicySet;

PolicySet.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySet;

PolicySet.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySet;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing PolicySet that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#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 PolicySet 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.
vcsRepo PolicySetVcsRepoOutputReference No description.
agentEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
descriptionInput java.lang.String No description.
globalInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
kindInput java.lang.String No description.
nameInput java.lang.String No description.
organizationInput java.lang.String No description.
overridableInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
policiesPathInput java.lang.String No description.
policyIdsInput java.util.List<java.lang.String> No description.
policyToolVersionInput java.lang.String No description.
slugInput java.util.Map<java.lang.String, java.lang.String> No description.
vcsRepoInput PolicySetVcsRepo No description.
workspaceIdsInput java.util.List<java.lang.String> No description.
agentEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
description java.lang.String No description.
global java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
kind java.lang.String No description.
name java.lang.String No description.
organization java.lang.String No description.
overridable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
policiesPath java.lang.String No description.
policyIds java.util.List<java.lang.String> No description.
policyToolVersion java.lang.String No description.
slug java.util.Map<java.lang.String, java.lang.String> No description.
workspaceIds 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
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>
vcsRepoRequired 
public PolicySetVcsRepoOutputReference getVcsRepo();
agentEnabledInputOptional 
public java.lang.Object getAgentEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
globalInputOptional 
public java.lang.Object getGlobalInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
kindInputOptional 
public java.lang.String getKindInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
organizationInputOptional 
public java.lang.String getOrganizationInput();
  • Type: java.lang.String
overridableInputOptional 
public java.lang.Object getOverridableInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
policiesPathInputOptional 
public java.lang.String getPoliciesPathInput();
  • Type: java.lang.String
policyIdsInputOptional 
public java.util.List<java.lang.String> getPolicyIdsInput();
  • Type: java.util.List<java.lang.String>
policyToolVersionInputOptional 
public java.lang.String getPolicyToolVersionInput();
  • Type: java.lang.String
slugInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getSlugInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
vcsRepoInputOptional 
public PolicySetVcsRepo getVcsRepoInput();
workspaceIdsInputOptional 
public java.util.List<java.lang.String> getWorkspaceIdsInput();
  • Type: java.util.List<java.lang.String>
agentEnabledRequired 
public java.lang.Object getAgentEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
globalRequired 
public java.lang.Object getGlobal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
kindRequired 
public java.lang.String getKind();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
organizationRequired 
public java.lang.String getOrganization();
  • Type: java.lang.String
overridableRequired 
public java.lang.Object getOverridable();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
policiesPathRequired 
public java.lang.String getPoliciesPath();
  • Type: java.lang.String
policyIdsRequired 
public java.util.List<java.lang.String> getPolicyIds();
  • Type: java.util.List<java.lang.String>
policyToolVersionRequired 
public java.lang.String getPolicyToolVersion();
  • Type: java.lang.String
slugRequired 
public java.util.Map<java.lang.String, java.lang.String> getSlug();
  • Type: java.util.Map<java.lang.String, java.lang.String>
workspaceIdsRequired 
public java.util.List<java.lang.String> getWorkspaceIds();
  • 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

PolicySetConfig

Initializer 

import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySetConfig;

PolicySetConfig.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)
//  .agentEnabled(java.lang.Boolean)
//  .agentEnabled(IResolvable)
//  .description(java.lang.String)
//  .global(java.lang.Boolean)
//  .global(IResolvable)
//  .id(java.lang.String)
//  .kind(java.lang.String)
//  .organization(java.lang.String)
//  .overridable(java.lang.Boolean)
//  .overridable(IResolvable)
//  .policiesPath(java.lang.String)
//  .policyIds(java.util.List<java.lang.String>)
//  .policyToolVersion(java.lang.String)
//  .slug(java.util.Map<java.lang.String, java.lang.String>)
//  .vcsRepo(PolicySetVcsRepo)
//  .workspaceIds(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/resources/policy_set#name PolicySet#name}.
agentEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#description PolicySet#description}.
global java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#global PolicySet#global}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#id PolicySet#id}.
kind java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#kind PolicySet#kind}.
organization java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#organization PolicySet#organization}.
overridable java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#overridable PolicySet#overridable}.
policiesPath java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.
policyIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.
policyToolVersion java.lang.String The policy tool version to run the policy evaluation against.
slug java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#slug PolicySet#slug}.
vcsRepo PolicySetVcsRepo vcs_repo block.
workspaceIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#workspace_ids PolicySet#workspace_ids}.
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/resources/policy_set#name PolicySet#name}.

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

Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#agent_enabled PolicySet#agent_enabled}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#description PolicySet#description}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#global PolicySet#global}.

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/resources/policy_set#id PolicySet#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.

kindOptional 
public java.lang.String getKind();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#kind PolicySet#kind}.

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/resources/policy_set#organization PolicySet#organization}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#overridable PolicySet#overridable}.

policiesPathOptional 
public java.lang.String getPoliciesPath();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.

policyIdsOptional 
public java.util.List<java.lang.String> getPolicyIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.

policyToolVersionOptional 
public java.lang.String getPolicyToolVersion();
  • Type: java.lang.String

The policy tool version to run the policy evaluation against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#policy_tool_version PolicySet#policy_tool_version}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#slug PolicySet#slug}.

vcsRepoOptional 
public PolicySetVcsRepo getVcsRepo();

vcs_repo block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#vcs_repo PolicySet#vcs_repo}

workspaceIdsOptional 
public java.util.List<java.lang.String> getWorkspaceIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#workspace_ids PolicySet#workspace_ids}.

PolicySetVcsRepo

Initializer 

import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySetVcsRepo;

PolicySetVcsRepo.builder()
    .identifier(java.lang.String)
//  .branch(java.lang.String)
//  .githubAppInstallationId(java.lang.String)
//  .ingressSubmodules(java.lang.Boolean)
//  .ingressSubmodules(IResolvable)
//  .oauthTokenId(java.lang.String)
    .build();

Properties

Name Type Description
identifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#identifier PolicySet#identifier}.
branch java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#branch PolicySet#branch}.
githubAppInstallationId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.
ingressSubmodules java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.
oauthTokenId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.
identifierRequired 
public java.lang.String getIdentifier();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#identifier PolicySet#identifier}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#branch PolicySet#branch}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.

Classes

PolicySetVcsRepoOutputReference

Initializers 

import com.hashicorp.cdktf.providers.tfe.policy_set.PolicySetVcsRepoOutputReference;

new PolicySetVcsRepoOutputReference(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.
resetBranch No description.
resetGithubAppInstallationId No description.
resetIngressSubmodules No description.
resetOauthTokenId 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.

resetBranch 
public void resetBranch()
resetGithubAppInstallationId 
public void resetGithubAppInstallationId()
resetIngressSubmodules 
public void resetIngressSubmodules()
resetOauthTokenId 
public void resetOauthTokenId()

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.
branchInput java.lang.String No description.
githubAppInstallationIdInput java.lang.String No description.
identifierInput java.lang.String No description.
ingressSubmodulesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oauthTokenIdInput java.lang.String No description.
branch java.lang.String No description.
githubAppInstallationId java.lang.String No description.
identifier java.lang.String No description.
ingressSubmodules java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
oauthTokenId java.lang.String No description.
internalValue PolicySetVcsRepo 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
branchInputOptional 
public java.lang.String getBranchInput();
  • Type: java.lang.String
githubAppInstallationIdInputOptional 
public java.lang.String getGithubAppInstallationIdInput();
  • Type: java.lang.String
identifierInputOptional 
public java.lang.String getIdentifierInput();
  • Type: java.lang.String
ingressSubmodulesInputOptional 
public java.lang.Object getIngressSubmodulesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
oauthTokenIdInputOptional 
public java.lang.String getOauthTokenIdInput();
  • 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 java.lang.Object getIngressSubmodules();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
oauthTokenIdRequired 
public java.lang.String getOauthTokenId();
  • Type: java.lang.String
internalValueOptional 
public PolicySetVcsRepo getInternalValue();