samlsettings

package
v9.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 13, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

tfe_saml_settings

Refer to the Terraform Registory for docs: tfe_saml_settings.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewSamlSettings_Override 

func NewSamlSettings_Override(s SamlSettings, scope constructs.Construct, id *string, config *SamlSettingsConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings tfe_saml_settings} Resource.

func SamlSettings_IsConstruct 

func SamlSettings_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func SamlSettings_IsTerraformElement 

func SamlSettings_IsTerraformElement(x interface{}) *bool

Experimental.

func SamlSettings_IsTerraformResource 

func SamlSettings_IsTerraformResource(x interface{}) *bool

Experimental.

func SamlSettings_TfResourceType 

func SamlSettings_TfResourceType() *string

Types

type SamlSettings 

type SamlSettings interface {
	cdktf.TerraformResource
	AcsConsumerUrl() *string
	AttrGroups() *string
	SetAttrGroups(val *string)
	AttrGroupsInput() *string
	AttrSiteAdmin() *string
	SetAttrSiteAdmin(val *string)
	AttrSiteAdminInput() *string
	AttrUsername() *string
	SetAttrUsername(val *string)
	AttrUsernameInput() *string
	AuthnRequestsSigned() interface{}
	SetAuthnRequestsSigned(val interface{})
	AuthnRequestsSignedInput() interface{}
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Certificate() *string
	SetCertificate(val *string)
	CertificateInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Debug() interface{}
	SetDebug(val interface{})
	DebugInput() interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Enabled() cdktf.IResolvable
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	IdpCert() *string
	SetIdpCert(val *string)
	IdpCertInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MetadataUrl() *string
	// The tree node.
	Node() constructs.Node
	OldIdpCert() *string
	PrivateKey() *string
	SetPrivateKey(val *string)
	PrivateKeyInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	SignatureDigestMethod() *string
	SetSignatureDigestMethod(val *string)
	SignatureDigestMethodInput() *string
	SignatureSigningMethod() *string
	SetSignatureSigningMethod(val *string)
	SignatureSigningMethodInput() *string
	SiteAdminRole() *string
	SetSiteAdminRole(val *string)
	SiteAdminRoleInput() *string
	SloEndpointUrl() *string
	SetSloEndpointUrl(val *string)
	SloEndpointUrlInput() *string
	SsoApiTokenSessionTimeout() *float64
	SetSsoApiTokenSessionTimeout(val *float64)
	SsoApiTokenSessionTimeoutInput() *float64
	SsoEndpointUrl() *string
	SetSsoEndpointUrl(val *string)
	SsoEndpointUrlInput() *string
	TeamManagementEnabled() interface{}
	SetTeamManagementEnabled(val interface{})
	TeamManagementEnabledInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	WantAssertionsSigned() interface{}
	SetWantAssertionsSigned(val interface{})
	WantAssertionsSignedInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAttrGroups()
	ResetAttrSiteAdmin()
	ResetAttrUsername()
	ResetAuthnRequestsSigned()
	ResetCertificate()
	ResetDebug()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPrivateKey()
	ResetSignatureDigestMethod()
	ResetSignatureSigningMethod()
	ResetSiteAdminRole()
	ResetSsoApiTokenSessionTimeout()
	ResetTeamManagementEnabled()
	ResetWantAssertionsSigned()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewSamlSettings 

func NewSamlSettings(scope constructs.Construct, id *string, config *SamlSettingsConfig) SamlSettings

Create a new {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings tfe_saml_settings} Resource.

type SamlSettingsConfig 

type SamlSettingsConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// 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.49.2/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}
	IdpCert *string `field:"required" json:"idpCert" yaml:"idpCert"`
	// 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.49.2/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}
	SloEndpointUrl *string `field:"required" json:"sloEndpointUrl" yaml:"sloEndpointUrl"`
	// 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.49.2/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}
	SsoEndpointUrl *string `field:"required" json:"ssoEndpointUrl" yaml:"ssoEndpointUrl"`
	// 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.49.2/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}
	AttrGroups *string `field:"optional" json:"attrGroups" yaml:"attrGroups"`
	// 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.49.2/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}
	AttrSiteAdmin *string `field:"optional" json:"attrSiteAdmin" yaml:"attrSiteAdmin"`
	// 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.49.2/docs/resources/saml_settings#attr_username SamlSettings#attr_username}
	AttrUsername *string `field:"optional" json:"attrUsername" yaml:"attrUsername"`
	// Ensure that <samlp:AuthnRequest> messages are signed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}
	AuthnRequestsSigned interface{} `field:"optional" json:"authnRequestsSigned" yaml:"authnRequestsSigned"`
	// The certificate used for request and assertion signing.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings#certificate SamlSettings#certificate}
	Certificate *string `field:"optional" json:"certificate" yaml:"certificate"`
	// 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.49.2/docs/resources/saml_settings#debug SamlSettings#debug}
	Debug interface{} `field:"optional" json:"debug" yaml:"debug"`
	// The private key used for request and assertion signing.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings#private_key SamlSettings#private_key}
	PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"`
	// 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.49.2/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}
	SignatureDigestMethod *string `field:"optional" json:"signatureDigestMethod" yaml:"signatureDigestMethod"`
	// 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.49.2/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}
	SignatureSigningMethod *string `field:"optional" json:"signatureSigningMethod" yaml:"signatureSigningMethod"`
	// 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.49.2/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}
	SiteAdminRole *string `field:"optional" json:"siteAdminRole" yaml:"siteAdminRole"`
	// 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.49.2/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}
	SsoApiTokenSessionTimeout *float64 `field:"optional" json:"ssoApiTokenSessionTimeout" yaml:"ssoApiTokenSessionTimeout"`
	// 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.49.2/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}
	TeamManagementEnabled interface{} `field:"optional" json:"teamManagementEnabled" yaml:"teamManagementEnabled"`
	// Ensure that <saml:Assertion> elements are signed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.49.2/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}
	WantAssertionsSigned interface{} `field:"optional" json:"wantAssertionsSigned" yaml:"wantAssertionsSigned"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.