Skip to content

Latest commit

 

History

History
1790 lines (1122 loc) · 79 KB

samlSettings.java.md

File metadata and controls

1790 lines (1122 loc) · 79 KB

samlSettings Submodule

Constructs

SamlSettings

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

Initializers 

import com.hashicorp.cdktf.providers.tfe.saml_settings.SamlSettings;

SamlSettings.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>)
    .idpCert(java.lang.String)
    .sloEndpointUrl(java.lang.String)
    .ssoEndpointUrl(java.lang.String)
//  .attrGroups(java.lang.String)
//  .attrSiteAdmin(java.lang.String)
//  .attrUsername(java.lang.String)
//  .authnRequestsSigned(java.lang.Boolean)
//  .authnRequestsSigned(IResolvable)
//  .certificate(java.lang.String)
//  .debug(java.lang.Boolean)
//  .debug(IResolvable)
//  .privateKey(java.lang.String)
//  .signatureDigestMethod(java.lang.String)
//  .signatureSigningMethod(java.lang.String)
//  .siteAdminRole(java.lang.String)
//  .ssoApiTokenSessionTimeout(java.lang.Number)
//  .teamManagementEnabled(java.lang.Boolean)
//  .teamManagementEnabled(IResolvable)
//  .wantAssertionsSigned(java.lang.Boolean)
//  .wantAssertionsSigned(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.
idpCert java.lang.String Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.
sloEndpointUrl java.lang.String Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.
ssoEndpointUrl java.lang.String Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.
attrGroups java.lang.String Team Attribute Name specifies the name of the SAML attribute that determines team membership.
attrSiteAdmin java.lang.String Specifies the role for site admin access. Overrides the "Site Admin Role" method.
attrUsername java.lang.String Username Attribute Name specifies the name of the SAML attribute that determines the user's username.
authnRequestsSigned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Ensure that samlp:AuthnRequest messages are signed.
certificate java.lang.String The certificate used for request and assertion signing.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.
privateKey java.lang.String The private key used for request and assertion signing.
signatureDigestMethod java.lang.String Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.
signatureSigningMethod java.lang.String Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.
siteAdminRole java.lang.String Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.
ssoApiTokenSessionTimeout java.lang.Number Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
teamManagementEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set it to false if you would rather use Terraform Enterprise to manage team membership.
wantAssertionsSigned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Ensure that saml:Assertion elements are signed.
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>
idpCertRequired
  • Type: java.lang.String

Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}

sloEndpointUrlRequired
  • Type: java.lang.String

Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}

ssoEndpointUrlRequired
  • Type: java.lang.String

Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}

attrGroupsOptional
  • Type: java.lang.String

Team Attribute Name specifies the name of the SAML attribute that determines team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}

attrSiteAdminOptional
  • Type: java.lang.String

Specifies the role for site admin access. Overrides the "Site Admin Role" method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}

attrUsernameOptional
  • Type: java.lang.String

Username Attribute Name specifies the name of the SAML attribute that determines the user's username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_username SamlSettings#attr_username}

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

Ensure that samlp:AuthnRequest messages are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}

certificateOptional
  • Type: java.lang.String

The certificate used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#certificate SamlSettings#certificate}

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

When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#debug SamlSettings#debug}

privateKeyOptional
  • Type: java.lang.String

The private key used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#private_key SamlSettings#private_key}

signatureDigestMethodOptional
  • Type: java.lang.String

Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}

signatureSigningMethodOptional
  • Type: java.lang.String

Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}

siteAdminRoleOptional
  • Type: java.lang.String

Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}

ssoApiTokenSessionTimeoutOptional
  • Type: java.lang.Number

Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}

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

Set it to false if you would rather use Terraform Enterprise to manage team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}

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

Ensure that saml:Assertion elements are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}

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".
resetAttrGroups No description.
resetAttrSiteAdmin No description.
resetAttrUsername No description.
resetAuthnRequestsSigned No description.
resetCertificate No description.
resetDebug No description.
resetPrivateKey No description.
resetSignatureDigestMethod No description.
resetSignatureSigningMethod No description.
resetSiteAdminRole No description.
resetSsoApiTokenSessionTimeout No description.
resetTeamManagementEnabled No description.
resetWantAssertionsSigned 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".

resetAttrGroups 
public void resetAttrGroups()
resetAttrSiteAdmin 
public void resetAttrSiteAdmin()
resetAttrUsername 
public void resetAttrUsername()
resetAuthnRequestsSigned 
public void resetAuthnRequestsSigned()
resetCertificate 
public void resetCertificate()
resetDebug 
public void resetDebug()
resetPrivateKey 
public void resetPrivateKey()
resetSignatureDigestMethod 
public void resetSignatureDigestMethod()
resetSignatureSigningMethod 
public void resetSignatureSigningMethod()
resetSiteAdminRole 
public void resetSiteAdminRole()
resetSsoApiTokenSessionTimeout 
public void resetSsoApiTokenSessionTimeout()
resetTeamManagementEnabled 
public void resetTeamManagementEnabled()
resetWantAssertionsSigned 
public void resetWantAssertionsSigned()

Static Functions

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

SamlSettings.isConstruct(java.lang.Object x)

Checks if x is a construct.

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

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

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.tfe.saml_settings.SamlSettings;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing SamlSettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#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 SamlSettings 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.
acsConsumerUrl java.lang.String No description.
enabled com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
metadataUrl java.lang.String No description.
oldIdpCert java.lang.String No description.
attrGroupsInput java.lang.String No description.
attrSiteAdminInput java.lang.String No description.
attrUsernameInput java.lang.String No description.
authnRequestsSignedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
certificateInput java.lang.String No description.
debugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idpCertInput java.lang.String No description.
privateKeyInput java.lang.String No description.
signatureDigestMethodInput java.lang.String No description.
signatureSigningMethodInput java.lang.String No description.
siteAdminRoleInput java.lang.String No description.
sloEndpointUrlInput java.lang.String No description.
ssoApiTokenSessionTimeoutInput java.lang.Number No description.
ssoEndpointUrlInput java.lang.String No description.
teamManagementEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
wantAssertionsSignedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
attrGroups java.lang.String No description.
attrSiteAdmin java.lang.String No description.
attrUsername java.lang.String No description.
authnRequestsSigned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
certificate java.lang.String No description.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idpCert java.lang.String No description.
privateKey java.lang.String No description.
signatureDigestMethod java.lang.String No description.
signatureSigningMethod java.lang.String No description.
siteAdminRole java.lang.String No description.
sloEndpointUrl java.lang.String No description.
ssoApiTokenSessionTimeout java.lang.Number No description.
ssoEndpointUrl java.lang.String No description.
teamManagementEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
wantAssertionsSigned 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>
acsConsumerUrlRequired 
public java.lang.String getAcsConsumerUrl();
  • Type: java.lang.String
enabledRequired 
public IResolvable getEnabled();
  • Type: com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
metadataUrlRequired 
public java.lang.String getMetadataUrl();
  • Type: java.lang.String
oldIdpCertRequired 
public java.lang.String getOldIdpCert();
  • Type: java.lang.String
attrGroupsInputOptional 
public java.lang.String getAttrGroupsInput();
  • Type: java.lang.String
attrSiteAdminInputOptional 
public java.lang.String getAttrSiteAdminInput();
  • Type: java.lang.String
attrUsernameInputOptional 
public java.lang.String getAttrUsernameInput();
  • Type: java.lang.String
authnRequestsSignedInputOptional 
public java.lang.Object getAuthnRequestsSignedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
certificateInputOptional 
public java.lang.String getCertificateInput();
  • Type: java.lang.String
debugInputOptional 
public java.lang.Object getDebugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idpCertInputOptional 
public java.lang.String getIdpCertInput();
  • Type: java.lang.String
privateKeyInputOptional 
public java.lang.String getPrivateKeyInput();
  • Type: java.lang.String
signatureDigestMethodInputOptional 
public java.lang.String getSignatureDigestMethodInput();
  • Type: java.lang.String
signatureSigningMethodInputOptional 
public java.lang.String getSignatureSigningMethodInput();
  • Type: java.lang.String
siteAdminRoleInputOptional 
public java.lang.String getSiteAdminRoleInput();
  • Type: java.lang.String
sloEndpointUrlInputOptional 
public java.lang.String getSloEndpointUrlInput();
  • Type: java.lang.String
ssoApiTokenSessionTimeoutInputOptional 
public java.lang.Number getSsoApiTokenSessionTimeoutInput();
  • Type: java.lang.Number
ssoEndpointUrlInputOptional 
public java.lang.String getSsoEndpointUrlInput();
  • Type: java.lang.String
teamManagementEnabledInputOptional 
public java.lang.Object getTeamManagementEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
wantAssertionsSignedInputOptional 
public java.lang.Object getWantAssertionsSignedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
attrGroupsRequired 
public java.lang.String getAttrGroups();
  • Type: java.lang.String
attrSiteAdminRequired 
public java.lang.String getAttrSiteAdmin();
  • Type: java.lang.String
attrUsernameRequired 
public java.lang.String getAttrUsername();
  • Type: java.lang.String
authnRequestsSignedRequired 
public java.lang.Object getAuthnRequestsSigned();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
certificateRequired 
public java.lang.String getCertificate();
  • Type: java.lang.String
debugRequired 
public java.lang.Object getDebug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idpCertRequired 
public java.lang.String getIdpCert();
  • Type: java.lang.String
privateKeyRequired 
public java.lang.String getPrivateKey();
  • Type: java.lang.String
signatureDigestMethodRequired 
public java.lang.String getSignatureDigestMethod();
  • Type: java.lang.String
signatureSigningMethodRequired 
public java.lang.String getSignatureSigningMethod();
  • Type: java.lang.String
siteAdminRoleRequired 
public java.lang.String getSiteAdminRole();
  • Type: java.lang.String
sloEndpointUrlRequired 
public java.lang.String getSloEndpointUrl();
  • Type: java.lang.String
ssoApiTokenSessionTimeoutRequired 
public java.lang.Number getSsoApiTokenSessionTimeout();
  • Type: java.lang.Number
ssoEndpointUrlRequired 
public java.lang.String getSsoEndpointUrl();
  • Type: java.lang.String
teamManagementEnabledRequired 
public java.lang.Object getTeamManagementEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
wantAssertionsSignedRequired 
public java.lang.Object getWantAssertionsSigned();
  • 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

SamlSettingsConfig

Initializer 

import com.hashicorp.cdktf.providers.tfe.saml_settings.SamlSettingsConfig;

SamlSettingsConfig.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>)
    .idpCert(java.lang.String)
    .sloEndpointUrl(java.lang.String)
    .ssoEndpointUrl(java.lang.String)
//  .attrGroups(java.lang.String)
//  .attrSiteAdmin(java.lang.String)
//  .attrUsername(java.lang.String)
//  .authnRequestsSigned(java.lang.Boolean)
//  .authnRequestsSigned(IResolvable)
//  .certificate(java.lang.String)
//  .debug(java.lang.Boolean)
//  .debug(IResolvable)
//  .privateKey(java.lang.String)
//  .signatureDigestMethod(java.lang.String)
//  .signatureSigningMethod(java.lang.String)
//  .siteAdminRole(java.lang.String)
//  .ssoApiTokenSessionTimeout(java.lang.Number)
//  .teamManagementEnabled(java.lang.Boolean)
//  .teamManagementEnabled(IResolvable)
//  .wantAssertionsSigned(java.lang.Boolean)
//  .wantAssertionsSigned(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.
idpCert java.lang.String Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.
sloEndpointUrl java.lang.String Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.
ssoEndpointUrl java.lang.String Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.
attrGroups java.lang.String Team Attribute Name specifies the name of the SAML attribute that determines team membership.
attrSiteAdmin java.lang.String Specifies the role for site admin access. Overrides the "Site Admin Role" method.
attrUsername java.lang.String Username Attribute Name specifies the name of the SAML attribute that determines the user's username.
authnRequestsSigned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Ensure that samlp:AuthnRequest messages are signed.
certificate java.lang.String The certificate used for request and assertion signing.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.
privateKey java.lang.String The private key used for request and assertion signing.
signatureDigestMethod java.lang.String Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.
signatureSigningMethod java.lang.String Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.
siteAdminRole java.lang.String Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.
ssoApiTokenSessionTimeout java.lang.Number Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
teamManagementEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set it to false if you would rather use Terraform Enterprise to manage team membership.
wantAssertionsSigned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Ensure that saml:Assertion elements are signed.
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>
idpCertRequired 
public java.lang.String getIdpCert();
  • Type: java.lang.String

Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}

sloEndpointUrlRequired 
public java.lang.String getSloEndpointUrl();
  • Type: java.lang.String

Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}

ssoEndpointUrlRequired 
public java.lang.String getSsoEndpointUrl();
  • Type: java.lang.String

Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}

attrGroupsOptional 
public java.lang.String getAttrGroups();
  • Type: java.lang.String

Team Attribute Name specifies the name of the SAML attribute that determines team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}

attrSiteAdminOptional 
public java.lang.String getAttrSiteAdmin();
  • Type: java.lang.String

Specifies the role for site admin access. Overrides the "Site Admin Role" method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}

attrUsernameOptional 
public java.lang.String getAttrUsername();
  • Type: java.lang.String

Username Attribute Name specifies the name of the SAML attribute that determines the user's username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_username SamlSettings#attr_username}

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

Ensure that samlp:AuthnRequest messages are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}

certificateOptional 
public java.lang.String getCertificate();
  • Type: java.lang.String

The certificate used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#certificate SamlSettings#certificate}

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

When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#debug SamlSettings#debug}

privateKeyOptional 
public java.lang.String getPrivateKey();
  • Type: java.lang.String

The private key used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#private_key SamlSettings#private_key}

signatureDigestMethodOptional 
public java.lang.String getSignatureDigestMethod();
  • Type: java.lang.String

Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}

signatureSigningMethodOptional 
public java.lang.String getSignatureSigningMethod();
  • Type: java.lang.String

Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}

siteAdminRoleOptional 
public java.lang.String getSiteAdminRole();
  • Type: java.lang.String

Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}

ssoApiTokenSessionTimeoutOptional 
public java.lang.Number getSsoApiTokenSessionTimeout();
  • Type: java.lang.Number

Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}

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

Set it to false if you would rather use Terraform Enterprise to manage team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}

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

Ensure that saml:Assertion elements are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}