samlauthbackend

README

vault_saml_auth_backend

Refer to the Terraform Registry for docs: vault_saml_auth_backend.

Documentation

Index

• func NewSamlAuthBackend_Override(s SamlAuthBackend, scope constructs.Construct, id *string, ...)
• func SamlAuthBackend_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func SamlAuthBackend_IsConstruct(x interface{}) *bool
• func SamlAuthBackend_IsTerraformElement(x interface{}) *bool
• func SamlAuthBackend_IsTerraformResource(x interface{}) *bool
• func SamlAuthBackend_TfResourceType() *string
• type SamlAuthBackend
  • func NewSamlAuthBackend(scope constructs.Construct, id *string, config *SamlAuthBackendConfig) SamlAuthBackend
• type SamlAuthBackendConfig

Functions

func NewSamlAuthBackend_Override

func NewSamlAuthBackend_Override(s SamlAuthBackend, scope constructs.Construct, id *string, config *SamlAuthBackendConfig)

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

func SamlAuthBackend_GenerateConfigForImport

func SamlAuthBackend_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a SamlAuthBackend resource upon running "cdktf plan <stack-name>".

func SamlAuthBackend_IsConstruct

func SamlAuthBackend_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 SamlAuthBackend_IsTerraformElement

func SamlAuthBackend_IsTerraformElement(x interface{}) *bool

Experimental.

func SamlAuthBackend_IsTerraformResource

func SamlAuthBackend_IsTerraformResource(x interface{}) *bool

Experimental.

func SamlAuthBackend_TfResourceType

func SamlAuthBackend_TfResourceType() *string

Types

type SamlAuthBackend

type SamlAuthBackend interface {
	cdktf.TerraformResource
	AcsUrls() *[]*string
	SetAcsUrls(val *[]*string)
	AcsUrlsInput() *[]*string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	DefaultRole() *string
	SetDefaultRole(val *string)
	DefaultRoleInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DisableRemount() interface{}
	SetDisableRemount(val interface{})
	DisableRemountInput() interface{}
	EntityId() *string
	SetEntityId(val *string)
	EntityIdInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	IdpCert() *string
	SetIdpCert(val *string)
	IdpCertInput() *string
	IdpEntityId() *string
	SetIdpEntityId(val *string)
	IdpEntityIdInput() *string
	IdpMetadataUrl() *string
	SetIdpMetadataUrl(val *string)
	IdpMetadataUrlInput() *string
	IdpSsoUrl() *string
	SetIdpSsoUrl(val *string)
	IdpSsoUrlInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	Path() *string
	SetPath(val *string)
	PathInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	VerboseLogging() interface{}
	SetVerboseLogging(val interface{})
	VerboseLoggingInput() interface{}
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// 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.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetDefaultRole()
	ResetDisableRemount()
	ResetId()
	ResetIdpCert()
	ResetIdpEntityId()
	ResetIdpMetadataUrl()
	ResetIdpSsoUrl()
	ResetNamespace()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPath()
	ResetVerboseLogging()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() 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/vault/4.5.0/docs/resources/saml_auth_backend vault_saml_auth_backend}.

func NewSamlAuthBackend

func NewSamlAuthBackend(scope constructs.Construct, id *string, config *SamlAuthBackendConfig) SamlAuthBackend

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

type SamlAuthBackendConfig

type SamlAuthBackendConfig 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"`
	// 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}
	AcsUrls *[]*string `field:"required" json:"acsUrls" yaml:"acsUrls"`
	// 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}
	EntityId *string `field:"required" json:"entityId" yaml:"entityId"`
	// 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}
	DefaultRole *string `field:"optional" json:"defaultRole" yaml:"defaultRole"`
	// 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}
	DisableRemount interface{} `field:"optional" json:"disableRemount" yaml:"disableRemount"`
	// 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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// 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}
	IdpCert *string `field:"optional" json:"idpCert" yaml:"idpCert"`
	// 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}
	IdpEntityId *string `field:"optional" json:"idpEntityId" yaml:"idpEntityId"`
	// 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}
	IdpMetadataUrl *string `field:"optional" json:"idpMetadataUrl" yaml:"idpMetadataUrl"`
	// 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}
	IdpSsoUrl *string `field:"optional" json:"idpSsoUrl" yaml:"idpSsoUrl"`
	// 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}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// 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}
	Path *string `field:"optional" json:"path" yaml:"path"`
	// 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}
	VerboseLogging interface{} `field:"optional" json:"verboseLogging" yaml:"verboseLogging"`
}