Skip to content

Latest commit

 

History

History
2753 lines (1712 loc) · 119 KB

gcpAuthBackend.typescript.md

File metadata and controls

2753 lines (1712 loc) · 119 KB

gcpAuthBackend Submodule

Constructs

GcpAuthBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend vault_gcp_auth_backend}.

Initializers

import { gcpAuthBackend } from '@cdktf/provider-vault'

new gcpAuthBackend.GcpAuthBackend(scope: Construct, id: string, config?: GcpAuthBackendConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GcpAuthBackendConfig 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


configOptional

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".
putCustomEndpoint No description.
putTune No description.
resetClientEmail No description.
resetClientId No description.
resetCredentials No description.
resetCustomEndpoint No description.
resetDescription No description.
resetDisableRemount No description.
resetId No description.
resetIdentityTokenAudience No description.
resetIdentityTokenKey No description.
resetIdentityTokenTtl No description.
resetLocal No description.
resetNamespace No description.
resetPath No description.
resetPrivateKeyId No description.
resetProjectId No description.
resetServiceAccountEmail No description.
resetTune 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".


putCustomEndpoint
public putCustomEndpoint(value: GcpAuthBackendCustomEndpoint): void
valueRequired

putTune
public putTune(value: IResolvable | GcpAuthBackendTune[]): void
valueRequired

resetClientEmail
public resetClientEmail(): void
resetClientId
public resetClientId(): void
resetCredentials
public resetCredentials(): void
resetCustomEndpoint
public resetCustomEndpoint(): void
resetDescription
public resetDescription(): void
resetDisableRemount
public resetDisableRemount(): void
resetId
public resetId(): void
resetIdentityTokenAudience
public resetIdentityTokenAudience(): void
resetIdentityTokenKey
public resetIdentityTokenKey(): void
resetIdentityTokenTtl
public resetIdentityTokenTtl(): void
resetLocal
public resetLocal(): void
resetNamespace
public resetNamespace(): void
resetPath
public resetPath(): void
resetPrivateKeyId
public resetPrivateKeyId(): void
resetProjectId
public resetProjectId(): void
resetServiceAccountEmail
public resetServiceAccountEmail(): void
resetTune
public resetTune(): 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 GcpAuthBackend resource upon running "cdktf plan ".

isConstruct
import { gcpAuthBackend } from '@cdktf/provider-vault'

gcpAuthBackend.GcpAuthBackend.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 { gcpAuthBackend } from '@cdktf/provider-vault'

gcpAuthBackend.GcpAuthBackend.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { gcpAuthBackend } from '@cdktf/provider-vault'

gcpAuthBackend.GcpAuthBackend.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { gcpAuthBackend } from '@cdktf/provider-vault'

gcpAuthBackend.GcpAuthBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing GcpAuthBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#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 GcpAuthBackend 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.
accessor string No description.
customEndpoint GcpAuthBackendCustomEndpointOutputReference No description.
tune GcpAuthBackendTuneList No description.
clientEmailInput string No description.
clientIdInput string No description.
credentialsInput string No description.
customEndpointInput GcpAuthBackendCustomEndpoint No description.
descriptionInput string No description.
disableRemountInput boolean | cdktf.IResolvable No description.
identityTokenAudienceInput string No description.
identityTokenKeyInput string No description.
identityTokenTtlInput number No description.
idInput string No description.
localInput boolean | cdktf.IResolvable No description.
namespaceInput string No description.
pathInput string No description.
privateKeyIdInput string No description.
projectIdInput string No description.
serviceAccountEmailInput string No description.
tuneInput cdktf.IResolvable | GcpAuthBackendTune[] No description.
clientEmail string No description.
clientId string No description.
credentials string No description.
description string No description.
disableRemount boolean | cdktf.IResolvable No description.
id string No description.
identityTokenAudience string No description.
identityTokenKey string No description.
identityTokenTtl number No description.
local boolean | cdktf.IResolvable No description.
namespace string No description.
path string No description.
privateKeyId string No description.
projectId string No description.
serviceAccountEmail 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[]

accessorRequired
public readonly accessor: string;
  • Type: string

customEndpointRequired
public readonly customEndpoint: GcpAuthBackendCustomEndpointOutputReference;

tuneRequired
public readonly tune: GcpAuthBackendTuneList;

clientEmailInputOptional
public readonly clientEmailInput: string;
  • Type: string

clientIdInputOptional
public readonly clientIdInput: string;
  • Type: string

credentialsInputOptional
public readonly credentialsInput: string;
  • Type: string

customEndpointInputOptional
public readonly customEndpointInput: GcpAuthBackendCustomEndpoint;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

disableRemountInputOptional
public readonly disableRemountInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

identityTokenAudienceInputOptional
public readonly identityTokenAudienceInput: string;
  • Type: string

identityTokenKeyInputOptional
public readonly identityTokenKeyInput: string;
  • Type: string

identityTokenTtlInputOptional
public readonly identityTokenTtlInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

localInputOptional
public readonly localInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

namespaceInputOptional
public readonly namespaceInput: string;
  • Type: string

pathInputOptional
public readonly pathInput: string;
  • Type: string

privateKeyIdInputOptional
public readonly privateKeyIdInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

serviceAccountEmailInputOptional
public readonly serviceAccountEmailInput: string;
  • Type: string

tuneInputOptional
public readonly tuneInput: IResolvable | GcpAuthBackendTune[];

clientEmailRequired
public readonly clientEmail: string;
  • Type: string

clientIdRequired
public readonly clientId: string;
  • Type: string

credentialsRequired
public readonly credentials: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

disableRemountRequired
public readonly disableRemount: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

identityTokenAudienceRequired
public readonly identityTokenAudience: string;
  • Type: string

identityTokenKeyRequired
public readonly identityTokenKey: string;
  • Type: string

identityTokenTtlRequired
public readonly identityTokenTtl: number;
  • Type: number

localRequired
public readonly local: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

namespaceRequired
public readonly namespace: string;
  • Type: string

pathRequired
public readonly path: string;
  • Type: string

privateKeyIdRequired
public readonly privateKeyId: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

serviceAccountEmailRequired
public readonly serviceAccountEmail: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GcpAuthBackendConfig

Initializer

import { gcpAuthBackend } from '@cdktf/provider-vault'

const gcpAuthBackendConfig: gcpAuthBackend.GcpAuthBackendConfig = { ... }

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.
clientEmail string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#client_email GcpAuthBackend#client_email}.
clientId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#client_id GcpAuthBackend#client_id}.
credentials string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#credentials GcpAuthBackend#credentials}.
customEndpoint GcpAuthBackendCustomEndpoint custom_endpoint block.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#description GcpAuthBackend#description}.
disableRemount boolean | cdktf.IResolvable If set, opts out of mount migration on path updates.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#id GcpAuthBackend#id}.
identityTokenAudience string The audience claim value for plugin identity tokens.
identityTokenKey string The key to use for signing identity tokens.
identityTokenTtl number The TTL of generated tokens.
local boolean | cdktf.IResolvable Specifies if the auth method is local only.
namespace string Target namespace. (requires Enterprise).
path string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#path GcpAuthBackend#path}.
privateKeyId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#private_key_id GcpAuthBackend#private_key_id}.
projectId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#project_id GcpAuthBackend#project_id}.
serviceAccountEmail string Service Account to impersonate for plugin workload identity federation.
tune cdktf.IResolvable | GcpAuthBackendTune[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#tune GcpAuthBackend#tune}.

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[]

clientEmailOptional
public readonly clientEmail: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#client_email GcpAuthBackend#client_email}.


clientIdOptional
public readonly clientId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#client_id GcpAuthBackend#client_id}.


credentialsOptional
public readonly credentials: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#credentials GcpAuthBackend#credentials}.


customEndpointOptional
public readonly customEndpoint: GcpAuthBackendCustomEndpoint;

custom_endpoint block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#custom_endpoint GcpAuthBackend#custom_endpoint}


descriptionOptional
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#description GcpAuthBackend#description}.


disableRemountOptional
public readonly disableRemount: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#disable_remount GcpAuthBackend#disable_remount}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#id GcpAuthBackend#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.


identityTokenAudienceOptional
public readonly identityTokenAudience: string;
  • Type: string

The audience claim value for plugin identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#identity_token_audience GcpAuthBackend#identity_token_audience}


identityTokenKeyOptional
public readonly identityTokenKey: string;
  • Type: string

The key to use for signing identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#identity_token_key GcpAuthBackend#identity_token_key}


identityTokenTtlOptional
public readonly identityTokenTtl: number;
  • Type: number

The TTL of generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#identity_token_ttl GcpAuthBackend#identity_token_ttl}


localOptional
public readonly local: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#local GcpAuthBackend#local}


namespaceOptional
public readonly namespace: string;
  • Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#namespace GcpAuthBackend#namespace}


pathOptional
public readonly path: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#path GcpAuthBackend#path}.


privateKeyIdOptional
public readonly privateKeyId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#private_key_id GcpAuthBackend#private_key_id}.


projectIdOptional
public readonly projectId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#project_id GcpAuthBackend#project_id}.


serviceAccountEmailOptional
public readonly serviceAccountEmail: string;
  • Type: string

Service Account to impersonate for plugin workload identity federation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#service_account_email GcpAuthBackend#service_account_email}


tuneOptional
public readonly tune: IResolvable | GcpAuthBackendTune[];

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#tune GcpAuthBackend#tune}.


GcpAuthBackendCustomEndpoint

Initializer

import { gcpAuthBackend } from '@cdktf/provider-vault'

const gcpAuthBackendCustomEndpoint: gcpAuthBackend.GcpAuthBackendCustomEndpoint = { ... }

Properties

Name Type Description
api string Replaces the service endpoint used in API requests to https://www.googleapis.com.
compute string Replaces the service endpoint used in API requests to https://compute.googleapis.com.
crm string Replaces the service endpoint used in API requests to https://cloudresourcemanager.googleapis.com.
iam string Replaces the service endpoint used in API requests to https://iam.googleapis.com.

apiOptional
public readonly api: string;
  • Type: string

Replaces the service endpoint used in API requests to https://www.googleapis.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#api GcpAuthBackend#api}


computeOptional
public readonly compute: string;
  • Type: string

Replaces the service endpoint used in API requests to https://compute.googleapis.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#compute GcpAuthBackend#compute}


crmOptional
public readonly crm: string;
  • Type: string

Replaces the service endpoint used in API requests to https://cloudresourcemanager.googleapis.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#crm GcpAuthBackend#crm}


iamOptional
public readonly iam: string;
  • Type: string

Replaces the service endpoint used in API requests to https://iam.googleapis.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#iam GcpAuthBackend#iam}


GcpAuthBackendTune

Initializer

import { gcpAuthBackend } from '@cdktf/provider-vault'

const gcpAuthBackendTune: gcpAuthBackend.GcpAuthBackendTune = { ... }

Properties

Name Type Description
allowedResponseHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#allowed_response_headers GcpAuthBackend#allowed_response_headers}.
auditNonHmacRequestKeys string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#audit_non_hmac_request_keys GcpAuthBackend#audit_non_hmac_request_keys}.
auditNonHmacResponseKeys string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#audit_non_hmac_response_keys GcpAuthBackend#audit_non_hmac_response_keys}.
defaultLeaseTtl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#default_lease_ttl GcpAuthBackend#default_lease_ttl}.
listingVisibility string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#listing_visibility GcpAuthBackend#listing_visibility}.
maxLeaseTtl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#max_lease_ttl GcpAuthBackend#max_lease_ttl}.
passthroughRequestHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#passthrough_request_headers GcpAuthBackend#passthrough_request_headers}.
tokenType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#token_type GcpAuthBackend#token_type}.

allowedResponseHeadersOptional
public readonly allowedResponseHeaders: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#allowed_response_headers GcpAuthBackend#allowed_response_headers}.


auditNonHmacRequestKeysOptional
public readonly auditNonHmacRequestKeys: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#audit_non_hmac_request_keys GcpAuthBackend#audit_non_hmac_request_keys}.


auditNonHmacResponseKeysOptional
public readonly auditNonHmacResponseKeys: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#audit_non_hmac_response_keys GcpAuthBackend#audit_non_hmac_response_keys}.


defaultLeaseTtlOptional
public readonly defaultLeaseTtl: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#default_lease_ttl GcpAuthBackend#default_lease_ttl}.


listingVisibilityOptional
public readonly listingVisibility: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#listing_visibility GcpAuthBackend#listing_visibility}.


maxLeaseTtlOptional
public readonly maxLeaseTtl: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#max_lease_ttl GcpAuthBackend#max_lease_ttl}.


passthroughRequestHeadersOptional
public readonly passthroughRequestHeaders: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#passthrough_request_headers GcpAuthBackend#passthrough_request_headers}.


tokenTypeOptional
public readonly tokenType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/gcp_auth_backend#token_type GcpAuthBackend#token_type}.


Classes

GcpAuthBackendCustomEndpointOutputReference

Initializers

import { gcpAuthBackend } from '@cdktf/provider-vault'

new gcpAuthBackend.GcpAuthBackendCustomEndpointOutputReference(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.
resetApi No description.
resetCompute No description.
resetCrm No description.
resetIam 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.

resetApi
public resetApi(): void
resetCompute
public resetCompute(): void
resetCrm
public resetCrm(): void
resetIam
public resetIam(): 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.
apiInput string No description.
computeInput string No description.
crmInput string No description.
iamInput string No description.
api string No description.
compute string No description.
crm string No description.
iam string No description.
internalValue GcpAuthBackendCustomEndpoint 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

apiInputOptional
public readonly apiInput: string;
  • Type: string

computeInputOptional
public readonly computeInput: string;
  • Type: string

crmInputOptional
public readonly crmInput: string;
  • Type: string

iamInputOptional
public readonly iamInput: string;
  • Type: string

apiRequired
public readonly api: string;
  • Type: string

computeRequired
public readonly compute: string;
  • Type: string

crmRequired
public readonly crm: string;
  • Type: string

iamRequired
public readonly iam: string;
  • Type: string

internalValueOptional
public readonly internalValue: GcpAuthBackendCustomEndpoint;

GcpAuthBackendTuneList

Initializers

import { gcpAuthBackend } from '@cdktf/provider-vault'

new gcpAuthBackend.GcpAuthBackendTuneList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

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


Methods

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

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): 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.

get
public get(index: number): GcpAuthBackendTuneOutputReference
indexRequired
  • Type: number

the index of the item to return.


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.
internalValue cdktf.IResolvable | GcpAuthBackendTune[] 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

internalValueOptional
public readonly internalValue: IResolvable | GcpAuthBackendTune[];

GcpAuthBackendTuneOutputReference

Initializers

import { gcpAuthBackend } from '@cdktf/provider-vault'

new gcpAuthBackend.GcpAuthBackendTuneOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

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


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAllowedResponseHeaders No description.
resetAuditNonHmacRequestKeys No description.
resetAuditNonHmacResponseKeys No description.
resetDefaultLeaseTtl No description.
resetListingVisibility No description.
resetMaxLeaseTtl No description.
resetPassthroughRequestHeaders No description.
resetTokenType 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.

resetAllowedResponseHeaders
public resetAllowedResponseHeaders(): void
resetAuditNonHmacRequestKeys
public resetAuditNonHmacRequestKeys(): void
resetAuditNonHmacResponseKeys
public resetAuditNonHmacResponseKeys(): void
resetDefaultLeaseTtl
public resetDefaultLeaseTtl(): void
resetListingVisibility
public resetListingVisibility(): void
resetMaxLeaseTtl
public resetMaxLeaseTtl(): void
resetPassthroughRequestHeaders
public resetPassthroughRequestHeaders(): void
resetTokenType
public resetTokenType(): 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.
allowedResponseHeadersInput string[] No description.
auditNonHmacRequestKeysInput string[] No description.
auditNonHmacResponseKeysInput string[] No description.
defaultLeaseTtlInput string No description.
listingVisibilityInput string No description.
maxLeaseTtlInput string No description.
passthroughRequestHeadersInput string[] No description.
tokenTypeInput string No description.
allowedResponseHeaders string[] No description.
auditNonHmacRequestKeys string[] No description.
auditNonHmacResponseKeys string[] No description.
defaultLeaseTtl string No description.
listingVisibility string No description.
maxLeaseTtl string No description.
passthroughRequestHeaders string[] No description.
tokenType string No description.
internalValue cdktf.IResolvable | GcpAuthBackendTune 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

allowedResponseHeadersInputOptional
public readonly allowedResponseHeadersInput: string[];
  • Type: string[]

auditNonHmacRequestKeysInputOptional
public readonly auditNonHmacRequestKeysInput: string[];
  • Type: string[]

auditNonHmacResponseKeysInputOptional
public readonly auditNonHmacResponseKeysInput: string[];
  • Type: string[]

defaultLeaseTtlInputOptional
public readonly defaultLeaseTtlInput: string;
  • Type: string

listingVisibilityInputOptional
public readonly listingVisibilityInput: string;
  • Type: string

maxLeaseTtlInputOptional
public readonly maxLeaseTtlInput: string;
  • Type: string

passthroughRequestHeadersInputOptional
public readonly passthroughRequestHeadersInput: string[];
  • Type: string[]

tokenTypeInputOptional
public readonly tokenTypeInput: string;
  • Type: string

allowedResponseHeadersRequired
public readonly allowedResponseHeaders: string[];
  • Type: string[]

auditNonHmacRequestKeysRequired
public readonly auditNonHmacRequestKeys: string[];
  • Type: string[]

auditNonHmacResponseKeysRequired
public readonly auditNonHmacResponseKeys: string[];
  • Type: string[]

defaultLeaseTtlRequired
public readonly defaultLeaseTtl: string;
  • Type: string

listingVisibilityRequired
public readonly listingVisibility: string;
  • Type: string

maxLeaseTtlRequired
public readonly maxLeaseTtl: string;
  • Type: string

passthroughRequestHeadersRequired
public readonly passthroughRequestHeaders: string[];
  • Type: string[]

tokenTypeRequired
public readonly tokenType: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GcpAuthBackendTune;