Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings tfe_saml_settings}.
import { samlSettings } from '@cdktf/provider-tfe'
new samlSettings.SamlSettings(scope: Construct, id: string, config: SamlSettingsConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
SamlSettingsConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: SamlSettingsConfig
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. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetAttrGroups(): void
public resetAttrSiteAdmin(): void
public resetAttrUsername(): void
public resetAuthnRequestsSigned(): void
public resetCertificate(): void
public resetDebug(): void
public resetPrivateKey(): void
public resetSignatureDigestMethod(): void
public resetSignatureSigningMethod(): void
public resetSiteAdminRole(): void
public resetSsoApiTokenSessionTimeout(): void
public resetTeamManagementEnabled(): void
public resetWantAssertionsSigned(): void
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 ". |
import { samlSettings } from '@cdktf/provider-tfe'
samlSettings.SamlSettings.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.
- Type: any
Any object.
import { samlSettings } from '@cdktf/provider-tfe'
samlSettings.SamlSettings.isTerraformElement(x: any)
- Type: any
import { samlSettings } from '@cdktf/provider-tfe'
samlSettings.SamlSettings.isTerraformResource(x: any)
- Type: any
import { samlSettings } from '@cdktf/provider-tfe'
samlSettings.SamlSettings.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a SamlSettings resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the SamlSettings to import.
- Type: 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
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the SamlSettings to import is found.
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. |
acsConsumerUrl |
string |
No description. |
enabled |
cdktf.IResolvable |
No description. |
id |
string |
No description. |
metadataUrl |
string |
No description. |
oldIdpCert |
string |
No description. |
attrGroupsInput |
string |
No description. |
attrSiteAdminInput |
string |
No description. |
attrUsernameInput |
string |
No description. |
authnRequestsSignedInput |
boolean | cdktf.IResolvable |
No description. |
certificateInput |
string |
No description. |
debugInput |
boolean | cdktf.IResolvable |
No description. |
idpCertInput |
string |
No description. |
privateKeyInput |
string |
No description. |
signatureDigestMethodInput |
string |
No description. |
signatureSigningMethodInput |
string |
No description. |
siteAdminRoleInput |
string |
No description. |
sloEndpointUrlInput |
string |
No description. |
ssoApiTokenSessionTimeoutInput |
number |
No description. |
ssoEndpointUrlInput |
string |
No description. |
teamManagementEnabledInput |
boolean | cdktf.IResolvable |
No description. |
wantAssertionsSignedInput |
boolean | cdktf.IResolvable |
No description. |
attrGroups |
string |
No description. |
attrSiteAdmin |
string |
No description. |
attrUsername |
string |
No description. |
authnRequestsSigned |
boolean | cdktf.IResolvable |
No description. |
certificate |
string |
No description. |
debug |
boolean | cdktf.IResolvable |
No description. |
idpCert |
string |
No description. |
privateKey |
string |
No description. |
signatureDigestMethod |
string |
No description. |
signatureSigningMethod |
string |
No description. |
siteAdminRole |
string |
No description. |
sloEndpointUrl |
string |
No description. |
ssoApiTokenSessionTimeout |
number |
No description. |
ssoEndpointUrl |
string |
No description. |
teamManagementEnabled |
boolean | cdktf.IResolvable |
No description. |
wantAssertionsSigned |
boolean | cdktf.IResolvable |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly acsConsumerUrl: string;
- Type: string
public readonly enabled: IResolvable;
- Type: cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly metadataUrl: string;
- Type: string
public readonly oldIdpCert: string;
- Type: string
public readonly attrGroupsInput: string;
- Type: string
public readonly attrSiteAdminInput: string;
- Type: string
public readonly attrUsernameInput: string;
- Type: string
public readonly authnRequestsSignedInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly certificateInput: string;
- Type: string
public readonly debugInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idpCertInput: string;
- Type: string
public readonly privateKeyInput: string;
- Type: string
public readonly signatureDigestMethodInput: string;
- Type: string
public readonly signatureSigningMethodInput: string;
- Type: string
public readonly siteAdminRoleInput: string;
- Type: string
public readonly sloEndpointUrlInput: string;
- Type: string
public readonly ssoApiTokenSessionTimeoutInput: number;
- Type: number
public readonly ssoEndpointUrlInput: string;
- Type: string
public readonly teamManagementEnabledInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly wantAssertionsSignedInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly attrGroups: string;
- Type: string
public readonly attrSiteAdmin: string;
- Type: string
public readonly attrUsername: string;
- Type: string
public readonly authnRequestsSigned: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly certificate: string;
- Type: string
public readonly debug: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idpCert: string;
- Type: string
public readonly privateKey: string;
- Type: string
public readonly signatureDigestMethod: string;
- Type: string
public readonly signatureSigningMethod: string;
- Type: string
public readonly siteAdminRole: string;
- Type: string
public readonly sloEndpointUrl: string;
- Type: string
public readonly ssoApiTokenSessionTimeout: number;
- Type: number
public readonly ssoEndpointUrl: string;
- Type: string
public readonly teamManagementEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly wantAssertionsSigned: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { samlSettings } from '@cdktf/provider-tfe'
const samlSettingsConfig: samlSettings.SamlSettingsConfig = { ... }
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. |
idpCert |
string |
Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration. |
sloEndpointUrl |
string |
Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests. |
ssoEndpointUrl |
string |
Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests. |
attrGroups |
string |
Team Attribute Name specifies the name of the SAML attribute that determines team membership. |
attrSiteAdmin |
string |
Specifies the role for site admin access. Overrides the "Site Admin Role" method. |
attrUsername |
string |
Username Attribute Name specifies the name of the SAML attribute that determines the user's username. |
authnRequestsSigned |
boolean | cdktf.IResolvable |
Ensure that samlp:AuthnRequest messages are signed. |
certificate |
string |
The certificate used for request and assertion signing. |
debug |
boolean | cdktf.IResolvable |
When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page. |
privateKey |
string |
The private key used for request and assertion signing. |
signatureDigestMethod |
string |
Signature Digest Method. Must be either SHA1 or SHA256 . Defaults to SHA256 . |
signatureSigningMethod |
string |
Signature Signing Method. Must be either SHA1 or SHA256 . Defaults to SHA256 . |
siteAdminRole |
string |
Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute. |
ssoApiTokenSessionTimeout |
number |
Specifies the Single Sign On session timeout in seconds. Defaults to 14 days. |
teamManagementEnabled |
boolean | cdktf.IResolvable |
Set it to false if you would rather use Terraform Enterprise to manage team membership. |
wantAssertionsSigned |
boolean | cdktf.IResolvable |
Ensure that saml:Assertion elements are signed. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly idpCert: string;
- Type: 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}
public readonly sloEndpointUrl: string;
- Type: 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}
public readonly ssoEndpointUrl: string;
- Type: 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}
public readonly attrGroups: string;
- Type: 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}
public readonly attrSiteAdmin: string;
- Type: 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}
public readonly attrUsername: string;
- Type: 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}
public readonly authnRequestsSigned: boolean | IResolvable;
- Type: boolean | 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}
public readonly certificate: string;
- Type: 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}
public readonly debug: boolean | IResolvable;
- Type: boolean | 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}
public readonly privateKey: string;
- Type: 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}
public readonly signatureDigestMethod: string;
- Type: 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}
public readonly signatureSigningMethod: string;
- Type: 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}
public readonly siteAdminRole: string;
- Type: 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}
public readonly ssoApiTokenSessionTimeout: number;
- Type: 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}
public readonly teamManagementEnabled: boolean | IResolvable;
- Type: boolean | 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}
public readonly wantAssertionsSigned: boolean | IResolvable;
- Type: boolean | 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}