Skip to content

Latest commit

 

History

History
1504 lines (942 loc) · 66.4 KB

samlAuthBackend.java.md

File metadata and controls

1504 lines (942 loc) · 66.4 KB

samlAuthBackend Submodule

Constructs

SamlAuthBackend

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

Initializers

import com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackend;

SamlAuthBackend.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .acsUrls(java.util.List<java.lang.String>)
    .entityId(java.lang.String)
//  .defaultRole(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .idpCert(java.lang.String)
//  .idpEntityId(java.lang.String)
//  .idpMetadataUrl(java.lang.String)
//  .idpSsoUrl(java.lang.String)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .verboseLogging(java.lang.Boolean)
//  .verboseLogging(IResolvable)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
acsUrls java.util.List<java.lang.String> The well-formatted URLs of your Assertion Consumer Service (ACS) that should receive a response from the identity provider.
entityId java.lang.String The entity ID of the SAML authentication service provider.
defaultRole java.lang.String The role to use if no role is provided during login.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend#id SamlAuthBackend#id}.
idpCert java.lang.String The PEM encoded certificate of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpEntityId java.lang.String The entity ID of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpMetadataUrl java.lang.String The metadata URL of the identity provider.
idpSsoUrl java.lang.String The SSO URL of the identity provider. Mutually exclusive with 'idp_metadata_url'.
namespace java.lang.String Target namespace. (requires Enterprise).
path java.lang.String Unique name of the auth backend to configure.
verboseLogging java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Log additional, potentially sensitive information during the SAML exchange according to the current logging level. Not recommended for production.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

acsUrlsRequired
  • Type: java.util.List<java.lang.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.5.0/docs/resources/saml_auth_backend#acs_urls SamlAuthBackend#acs_urls}


entityIdRequired
  • Type: java.lang.String

The entity ID of the SAML authentication service provider.

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


defaultRoleOptional
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#default_role SamlAuthBackend#default_role}


disableRemountOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.5.0/docs/resources/saml_auth_backend#disable_remount SamlAuthBackend#disable_remount}


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.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.


idpCertOptional
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_cert SamlAuthBackend#idp_cert}


idpEntityIdOptional
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_entity_id SamlAuthBackend#idp_entity_id}


idpMetadataUrlOptional
  • Type: java.lang.String

The metadata URL of the identity provider.

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


idpSsoUrlOptional
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_sso_url SamlAuthBackend#idp_sso_url}


namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

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


pathOptional
  • Type: java.lang.String

Unique name of the auth backend to configure.

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


verboseLoggingOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.5.0/docs/resources/saml_auth_backend#verbose_logging SamlAuthBackend#verbose_logging}


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 java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

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

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

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

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

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

idRequired
  • Type: java.lang.String

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


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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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


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

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


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

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

idRequired
  • Type: java.lang.String

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


resetDefaultRole
public void resetDefaultRole()
resetDisableRemount
public void resetDisableRemount()
resetId
public void resetId()
resetIdpCert
public void resetIdpCert()
resetIdpEntityId
public void resetIdpEntityId()
resetIdpMetadataUrl
public void resetIdpMetadataUrl()
resetIdpSsoUrl
public void resetIdpSsoUrl()
resetNamespace
public void resetNamespace()
resetPath
public void resetPath()
resetVerboseLogging
public void resetVerboseLogging()

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 com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackend;

SamlAuthBackend.isConstruct(java.lang.Object x)

Checks if x is a construct.

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

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

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackend;

SamlAuthBackend.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackend;

SamlAuthBackend.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackend;

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

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing SamlAuthBackend that should be imported.

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


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
acsUrlsInput java.util.List<java.lang.String> No description.
defaultRoleInput java.lang.String No description.
disableRemountInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
entityIdInput java.lang.String No description.
idInput java.lang.String No description.
idpCertInput java.lang.String No description.
idpEntityIdInput java.lang.String No description.
idpMetadataUrlInput java.lang.String No description.
idpSsoUrlInput java.lang.String No description.
namespaceInput java.lang.String No description.
pathInput java.lang.String No description.
verboseLoggingInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
acsUrls java.util.List<java.lang.String> No description.
defaultRole java.lang.String No description.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
entityId java.lang.String No description.
id java.lang.String No description.
idpCert java.lang.String No description.
idpEntityId java.lang.String No description.
idpMetadataUrl java.lang.String No description.
idpSsoUrl java.lang.String No description.
namespace java.lang.String No description.
path java.lang.String No description.
verboseLogging java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

acsUrlsInputOptional
public java.util.List<java.lang.String> getAcsUrlsInput();
  • Type: java.util.List<java.lang.String>

defaultRoleInputOptional
public java.lang.String getDefaultRoleInput();
  • Type: java.lang.String

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

entityIdInputOptional
public java.lang.String getEntityIdInput();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

idpCertInputOptional
public java.lang.String getIdpCertInput();
  • Type: java.lang.String

idpEntityIdInputOptional
public java.lang.String getIdpEntityIdInput();
  • Type: java.lang.String

idpMetadataUrlInputOptional
public java.lang.String getIdpMetadataUrlInput();
  • Type: java.lang.String

idpSsoUrlInputOptional
public java.lang.String getIdpSsoUrlInput();
  • Type: java.lang.String

namespaceInputOptional
public java.lang.String getNamespaceInput();
  • Type: java.lang.String

pathInputOptional
public java.lang.String getPathInput();
  • Type: java.lang.String

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

acsUrlsRequired
public java.util.List<java.lang.String> getAcsUrls();
  • Type: java.util.List<java.lang.String>

defaultRoleRequired
public java.lang.String getDefaultRole();
  • Type: java.lang.String

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

entityIdRequired
public java.lang.String getEntityId();
  • Type: java.lang.String

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

idpCertRequired
public java.lang.String getIdpCert();
  • Type: java.lang.String

idpEntityIdRequired
public java.lang.String getIdpEntityId();
  • Type: java.lang.String

idpMetadataUrlRequired
public java.lang.String getIdpMetadataUrl();
  • Type: java.lang.String

idpSsoUrlRequired
public java.lang.String getIdpSsoUrl();
  • Type: java.lang.String

namespaceRequired
public java.lang.String getNamespace();
  • Type: java.lang.String

pathRequired
public java.lang.String getPath();
  • Type: java.lang.String

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

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

SamlAuthBackendConfig

Initializer

import com.hashicorp.cdktf.providers.vault.saml_auth_backend.SamlAuthBackendConfig;

SamlAuthBackendConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .acsUrls(java.util.List<java.lang.String>)
    .entityId(java.lang.String)
//  .defaultRole(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .id(java.lang.String)
//  .idpCert(java.lang.String)
//  .idpEntityId(java.lang.String)
//  .idpMetadataUrl(java.lang.String)
//  .idpSsoUrl(java.lang.String)
//  .namespace(java.lang.String)
//  .path(java.lang.String)
//  .verboseLogging(java.lang.Boolean)
//  .verboseLogging(IResolvable)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
acsUrls java.util.List<java.lang.String> The well-formatted URLs of your Assertion Consumer Service (ACS) that should receive a response from the identity provider.
entityId java.lang.String The entity ID of the SAML authentication service provider.
defaultRole java.lang.String The role to use if no role is provided during login.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend#id SamlAuthBackend#id}.
idpCert java.lang.String The PEM encoded certificate of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpEntityId java.lang.String The entity ID of the identity provider. Mutually exclusive with 'idp_metadata_url'.
idpMetadataUrl java.lang.String The metadata URL of the identity provider.
idpSsoUrl java.lang.String The SSO URL of the identity provider. Mutually exclusive with 'idp_metadata_url'.
namespace java.lang.String Target namespace. (requires Enterprise).
path java.lang.String Unique name of the auth backend to configure.
verboseLogging java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Log additional, potentially sensitive information during the SAML exchange according to the current logging level. Not recommended for production.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

acsUrlsRequired
public java.util.List<java.lang.String> getAcsUrls();
  • Type: java.util.List<java.lang.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.5.0/docs/resources/saml_auth_backend#acs_urls SamlAuthBackend#acs_urls}


entityIdRequired
public java.lang.String getEntityId();
  • Type: java.lang.String

The entity ID of the SAML authentication service provider.

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


defaultRoleOptional
public java.lang.String getDefaultRole();
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#default_role SamlAuthBackend#default_role}


disableRemountOptional
public java.lang.Object getDisableRemount();
  • Type: java.lang.Boolean OR com.hashicorp.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.5.0/docs/resources/saml_auth_backend#disable_remount SamlAuthBackend#disable_remount}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.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.


idpCertOptional
public java.lang.String getIdpCert();
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_cert SamlAuthBackend#idp_cert}


idpEntityIdOptional
public java.lang.String getIdpEntityId();
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_entity_id SamlAuthBackend#idp_entity_id}


idpMetadataUrlOptional
public java.lang.String getIdpMetadataUrl();
  • Type: java.lang.String

The metadata URL of the identity provider.

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


idpSsoUrlOptional
public java.lang.String getIdpSsoUrl();
  • Type: java.lang.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.5.0/docs/resources/saml_auth_backend#idp_sso_url SamlAuthBackend#idp_sso_url}


namespaceOptional
public java.lang.String getNamespace();
  • Type: java.lang.String

Target namespace. (requires Enterprise).

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


pathOptional
public java.lang.String getPath();
  • Type: java.lang.String

Unique name of the auth backend to configure.

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


verboseLoggingOptional
public java.lang.Object getVerboseLogging();
  • Type: java.lang.Boolean OR com.hashicorp.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.5.0/docs/resources/saml_auth_backend#verbose_logging SamlAuthBackend#verbose_logging}