Skip to content

Latest commit

 

History

History
1833 lines (1142 loc) · 72.9 KB

policySet.typescript.md

File metadata and controls

1833 lines (1142 loc) · 72.9 KB

policySet Submodule

Constructs

PolicySet

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

Initializers 

import { policySet } from '@cdktf/provider-tfe'

new policySet.PolicySet(scope: Construct, id: string, config: PolicySetConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config PolicySetConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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 toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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: string

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

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

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

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 { policySet } from '@cdktf/provider-tfe'

policySet.PolicySet.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { policySet } from '@cdktf/provider-tfe'

policySet.PolicySet.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { policySet } from '@cdktf/provider-tfe'

policySet.PolicySet.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { policySet } from '@cdktf/provider-tfe'

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

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing PolicySet that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
vcsRepo PolicySetVcsRepoOutputReference No description.
agentEnabledInput boolean | cdktf.IResolvable No description.
descriptionInput string No description.
globalInput boolean | cdktf.IResolvable No description.
idInput string No description.
kindInput string No description.
nameInput string No description.
organizationInput string No description.
overridableInput boolean | cdktf.IResolvable No description.
policiesPathInput string No description.
policyIdsInput string[] No description.
policyToolVersionInput string No description.
slugInput {[ key: string ]: string} No description.
vcsRepoInput PolicySetVcsRepo No description.
workspaceIdsInput string[] No description.
agentEnabled boolean | cdktf.IResolvable No description.
description string No description.
global boolean | cdktf.IResolvable No description.
id string No description.
kind string No description.
name string No description.
organization string No description.
overridable boolean | cdktf.IResolvable No description.
policiesPath string No description.
policyIds string[] No description.
policyToolVersion string No description.
slug {[ key: string ]: string} No description.
workspaceIds string[] No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
vcsRepoRequired 
public readonly vcsRepo: PolicySetVcsRepoOutputReference;
agentEnabledInputOptional 
public readonly agentEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
globalInputOptional 
public readonly globalInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
kindInputOptional 
public readonly kindInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
organizationInputOptional 
public readonly organizationInput: string;
  • Type: string
overridableInputOptional 
public readonly overridableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
policiesPathInputOptional 
public readonly policiesPathInput: string;
  • Type: string
policyIdsInputOptional 
public readonly policyIdsInput: string[];
  • Type: string[]
policyToolVersionInputOptional 
public readonly policyToolVersionInput: string;
  • Type: string
slugInputOptional 
public readonly slugInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vcsRepoInputOptional 
public readonly vcsRepoInput: PolicySetVcsRepo;
workspaceIdsInputOptional 
public readonly workspaceIdsInput: string[];
  • Type: string[]
agentEnabledRequired 
public readonly agentEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
descriptionRequired 
public readonly description: string;
  • Type: string
globalRequired 
public readonly global: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
kindRequired 
public readonly kind: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
organizationRequired 
public readonly organization: string;
  • Type: string
overridableRequired 
public readonly overridable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
policiesPathRequired 
public readonly policiesPath: string;
  • Type: string
policyIdsRequired 
public readonly policyIds: string[];
  • Type: string[]
policyToolVersionRequired 
public readonly policyToolVersion: string;
  • Type: string
slugRequired 
public readonly slug: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
workspaceIdsRequired 
public readonly workspaceIds: string[];
  • Type: string[]

Constants

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

Structs

PolicySetConfig

Initializer 

import { policySet } from '@cdktf/provider-tfe'

const policySetConfig: policySet.PolicySetConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#name PolicySet#name}.
agentEnabled boolean | cdktf.IResolvable Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#description PolicySet#description}.
global boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#global PolicySet#global}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#id PolicySet#id}.
kind string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#kind PolicySet#kind}.
organization string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#organization PolicySet#organization}.
overridable boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#overridable PolicySet#overridable}.
policiesPath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#policies_path PolicySet#policies_path}.
policyIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#policy_ids PolicySet#policy_ids}.
policyToolVersion string The policy tool version to run the policy evaluation against.
slug {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#slug PolicySet#slug}.
vcsRepo PolicySetVcsRepo vcs_repo block.
workspaceIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#workspace_ids PolicySet#workspace_ids}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly name: string;
  • Type: string

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

agentEnabledOptional 
public readonly agentEnabled: boolean | IResolvable;
  • Type: boolean | 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.63.0/docs/resources/policy_set#agent_enabled PolicySet#agent_enabled}

descriptionOptional 
public readonly description: string;
  • Type: string

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

globalOptional 
public readonly global: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.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 readonly kind: string;
  • Type: string

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

organizationOptional 
public readonly organization: string;
  • Type: string

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

overridableOptional 
public readonly overridable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

policiesPathOptional 
public readonly policiesPath: string;
  • Type: string

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

policyIdsOptional 
public readonly policyIds: string[];
  • Type: string[]

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

policyToolVersionOptional 
public readonly policyToolVersion: string;
  • Type: string

The policy tool version to run the policy evaluation against.

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

slugOptional 
public readonly slug: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

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

vcsRepoOptional 
public readonly vcsRepo: PolicySetVcsRepo;

vcs_repo block.

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

workspaceIdsOptional 
public readonly workspaceIds: string[];
  • Type: string[]

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

PolicySetVcsRepo

Initializer 

import { policySet } from '@cdktf/provider-tfe'

const policySetVcsRepo: policySet.PolicySetVcsRepo = { ... }

Properties

Name Type Description
identifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#identifier PolicySet#identifier}.
branch string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#branch PolicySet#branch}.
githubAppInstallationId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#github_app_installation_id PolicySet#github_app_installation_id}.
ingressSubmodules boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#ingress_submodules PolicySet#ingress_submodules}.
oauthTokenId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/policy_set#oauth_token_id PolicySet#oauth_token_id}.
identifierRequired 
public readonly identifier: string;
  • Type: string

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

branchOptional 
public readonly branch: string;
  • Type: string

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

githubAppInstallationIdOptional 
public readonly githubAppInstallationId: string;
  • Type: string

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

ingressSubmodulesOptional 
public readonly ingressSubmodules: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

oauthTokenIdOptional 
public readonly oauthTokenId: string;
  • Type: string

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

Classes

PolicySetVcsRepoOutputReference

Initializers 

import { policySet } from '@cdktf/provider-tfe'

new policySet.PolicySetVcsRepoOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: 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 computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
branchInput string No description.
githubAppInstallationIdInput string No description.
identifierInput string No description.
ingressSubmodulesInput boolean | cdktf.IResolvable No description.
oauthTokenIdInput string No description.
branch string No description.
githubAppInstallationId string No description.
identifier string No description.
ingressSubmodules boolean | cdktf.IResolvable No description.
oauthTokenId string No description.
internalValue PolicySetVcsRepo No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: 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 readonly fqn: string;
  • Type: string
branchInputOptional 
public readonly branchInput: string;
  • Type: string
githubAppInstallationIdInputOptional 
public readonly githubAppInstallationIdInput: string;
  • Type: string
identifierInputOptional 
public readonly identifierInput: string;
  • Type: string
ingressSubmodulesInputOptional 
public readonly ingressSubmodulesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
oauthTokenIdInputOptional 
public readonly oauthTokenIdInput: string;
  • Type: string
branchRequired 
public readonly branch: string;
  • Type: string
githubAppInstallationIdRequired 
public readonly githubAppInstallationId: string;
  • Type: string
identifierRequired 
public readonly identifier: string;
  • Type: string
ingressSubmodulesRequired 
public readonly ingressSubmodules: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
oauthTokenIdRequired 
public readonly oauthTokenId: string;
  • Type: string
internalValueOptional 
public readonly internalValue: PolicySetVcsRepo;