samlAuthBackend.typescript.md

samlAuthBackend Submodule

Constructs

SamlAuthBackend

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

Initializers

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

new samlAuthBackend.SamlAuthBackend(scope: Construct, id: string, config: SamlAuthBackendConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	SamlAuthBackendConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: SamlAuthBackendConfig

---

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".
resetDefaultRole	No description.
resetDisableRemount	No description.
resetId	No description.
resetIdpCert	No description.
resetIdpEntityId	No description.
resetIdpMetadataUrl	No description.
resetIdpSsoUrl	No description.
resetNamespace	No description.
resetPath	No description.
resetVerboseLogging	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: string

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

---

index^Optional

• 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".

id^Required

• Type: string

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

---

resetDefaultRole

public resetDefaultRole(): void

resetDisableRemount

public resetDisableRemount(): void

resetId

public resetId(): void

resetIdpCert

public resetIdpCert(): void

resetIdpEntityId

public resetIdpEntityId(): void

resetIdpMetadataUrl

public resetIdpMetadataUrl(): void

resetIdpSsoUrl

public resetIdpSsoUrl(): void

resetNamespace

public resetNamespace(): void

resetPath

public resetPath(): void

resetVerboseLogging

public resetVerboseLogging(): 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 SamlAuthBackend resource upon running "cdktf plan ".

---

isConstruct

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

samlAuthBackend.SamlAuthBackend.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

samlAuthBackend.SamlAuthBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

samlAuthBackend.SamlAuthBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

samlAuthBackend.SamlAuthBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing SamlAuthBackend that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the SamlAuthBackend 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.
acsUrlsInput	string[]	No description.
defaultRoleInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
entityIdInput	string	No description.
idInput	string	No description.
idpCertInput	string	No description.
idpEntityIdInput	string	No description.
idpMetadataUrlInput	string	No description.
idpSsoUrlInput	string	No description.
namespaceInput	string	No description.
pathInput	string	No description.
verboseLoggingInput	boolean | cdktf.IResolvable	No description.
acsUrls	string[]	No description.
defaultRole	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
entityId	string	No description.
id	string	No description.
idpCert	string	No description.
idpEntityId	string	No description.
idpMetadataUrl	string	No description.
idpSsoUrl	string	No description.
namespace	string	No description.
path	string	No description.
verboseLogging	boolean | cdktf.IResolvable	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

acsUrlsInput^Optional

public readonly acsUrlsInput: string[];

• Type: string[]

---

defaultRoleInput^Optional

public readonly defaultRoleInput: string;

• Type: string

---

disableRemountInput^Optional

public readonly disableRemountInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

entityIdInput^Optional

public readonly entityIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

idpCertInput^Optional

public readonly idpCertInput: string;

• Type: string

---

idpEntityIdInput^Optional

public readonly idpEntityIdInput: string;

• Type: string

---

idpMetadataUrlInput^Optional

public readonly idpMetadataUrlInput: string;

• Type: string

---

idpSsoUrlInput^Optional

public readonly idpSsoUrlInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

verboseLoggingInput^Optional

public readonly verboseLoggingInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

acsUrls^Required

public readonly acsUrls: string[];

• Type: string[]

---

defaultRole^Required

public readonly defaultRole: string;

• Type: string

---

disableRemount^Required

public readonly disableRemount: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

entityId^Required

public readonly entityId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

idpCert^Required

public readonly idpCert: string;

• Type: string

---

idpEntityId^Required

public readonly idpEntityId: string;

• Type: string

---

idpMetadataUrl^Required

public readonly idpMetadataUrl: string;

• Type: string

---

idpSsoUrl^Required

public readonly idpSsoUrl: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

verboseLogging^Required

public readonly verboseLogging: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

SamlAuthBackendConfig

Initializer

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

const samlAuthBackendConfig: samlAuthBackend.SamlAuthBackendConfig = { ... }

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.
acsUrls	string[]	The well-formatted URLs of your Assertion Consumer Service (ACS) that should receive a response from the identity provider.
entityId	string	The entity ID of the SAML authentication service provider.
defaultRole	string	The role to use if no role is provided during login.
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/saml_auth_backend#id SamlAuthBackend#id}.
idpCert	string	The PEM encoded certificate of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpEntityId	string	The entity ID of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpMetadataUrl	string	The metadata URL of the identity provider.
idpSsoUrl	string	The SSO URL of the identity provider. Mutually exclusive with 'idp_metadata_url'.
namespace	string	Target namespace. (requires Enterprise).
path	string	Unique name of the auth backend to configure.
verboseLogging	boolean | cdktf.IResolvable	Log additional, potentially sensitive information during the SAML exchange according to the current logging level. Not recommended for production.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

acsUrls^Required

public readonly acsUrls: string[];

• Type: string[]

The well-formatted URLs of your Assertion Consumer Service (ACS) that should receive a response from the identity provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#acs_urls SamlAuthBackend#acs_urls}

---

entityId^Required

public readonly entityId: string;

• Type: string

The entity ID of the SAML authentication service provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#entity_id SamlAuthBackend#entity_id}

---

defaultRole^Optional

public readonly defaultRole: string;

• Type: string

The role to use if no role is provided during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#default_role SamlAuthBackend#default_role}

---

disableRemount^Optional

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/saml_auth_backend#disable_remount SamlAuthBackend#disable_remount}

---

id^Optional

public readonly id: string;

• Type: string

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

---

idpCert^Optional

public readonly idpCert: string;

• Type: string

The PEM encoded certificate of the identity provider. Mutually exclusive with 'idp_metadata_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#idp_cert SamlAuthBackend#idp_cert}

---

idpEntityId^Optional

public readonly idpEntityId: string;

• Type: string

The entity ID of the identity provider. Mutually exclusive with 'idp_metadata_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#idp_entity_id SamlAuthBackend#idp_entity_id}

---

idpMetadataUrl^Optional

public readonly idpMetadataUrl: string;

• Type: string

The metadata URL of the identity provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#idp_metadata_url SamlAuthBackend#idp_metadata_url}

---

idpSsoUrl^Optional

public readonly idpSsoUrl: string;

• Type: string

The SSO URL of the identity provider. Mutually exclusive with 'idp_metadata_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#idp_sso_url SamlAuthBackend#idp_sso_url}

---

namespace^Optional

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/saml_auth_backend#namespace SamlAuthBackend#namespace}

---

path^Optional

public readonly path: string;

• Type: string

Unique name of the auth backend to configure.

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

---

verboseLogging^Optional

public readonly verboseLogging: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Log additional, potentially sensitive information during the SAML exchange according to the current logging level. Not recommended for production.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/saml_auth_backend#verbose_logging SamlAuthBackend#verbose_logging}

---