Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role vault_saml_auth_backend_role}.
using HashiCorp.Cdktf.Providers.Vault;
new SamlAuthBackendRole(Construct Scope, string Id, SamlAuthBackendRoleConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
SamlAuthBackendRoleConfig |
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
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". |
ResetBoundAttributes |
No description. |
ResetBoundAttributesType |
No description. |
ResetBoundSubjects |
No description. |
ResetBoundSubjectsType |
No description. |
ResetGroupsAttribute |
No description. |
ResetId |
No description. |
ResetNamespace |
No description. |
ResetTokenBoundCidrs |
No description. |
ResetTokenExplicitMaxTtl |
No description. |
ResetTokenMaxTtl |
No description. |
ResetTokenNoDefaultPolicy |
No description. |
ResetTokenNumUses |
No description. |
ResetTokenPeriod |
No description. |
ResetTokenPolicies |
No description. |
ResetTokenTtl |
No description. |
ResetTokenType |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(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.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
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: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetBoundAttributes()
private void ResetBoundAttributesType()
private void ResetBoundSubjects()
private void ResetBoundSubjectsType()
private void ResetGroupsAttribute()
private void ResetId()
private void ResetNamespace()
private void ResetTokenBoundCidrs()
private void ResetTokenExplicitMaxTtl()
private void ResetTokenMaxTtl()
private void ResetTokenNoDefaultPolicy()
private void ResetTokenNumUses()
private void ResetTokenPeriod()
private void ResetTokenPolicies()
private void ResetTokenTtl()
private void ResetTokenType()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a SamlAuthBackendRole resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Vault;
SamlAuthBackendRole.IsConstruct(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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Vault;
SamlAuthBackendRole.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Vault;
SamlAuthBackendRole.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Vault;
SamlAuthBackendRole.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a SamlAuthBackendRole 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 SamlAuthBackendRole to import.
- Type: string
The id of the existing SamlAuthBackendRole that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the SamlAuthBackendRole to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
BoundAttributesInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
BoundAttributesTypeInput |
string |
No description. |
BoundSubjectsInput |
string[] |
No description. |
BoundSubjectsTypeInput |
string |
No description. |
GroupsAttributeInput |
string |
No description. |
IdInput |
string |
No description. |
NameInput |
string |
No description. |
NamespaceInput |
string |
No description. |
PathInput |
string |
No description. |
TokenBoundCidrsInput |
string[] |
No description. |
TokenExplicitMaxTtlInput |
double |
No description. |
TokenMaxTtlInput |
double |
No description. |
TokenNoDefaultPolicyInput |
object |
No description. |
TokenNumUsesInput |
double |
No description. |
TokenPeriodInput |
double |
No description. |
TokenPoliciesInput |
string[] |
No description. |
TokenTtlInput |
double |
No description. |
TokenTypeInput |
string |
No description. |
BoundAttributes |
System.Collections.Generic.IDictionary<string, string> |
No description. |
BoundAttributesType |
string |
No description. |
BoundSubjects |
string[] |
No description. |
BoundSubjectsType |
string |
No description. |
GroupsAttribute |
string |
No description. |
Id |
string |
No description. |
Name |
string |
No description. |
Namespace |
string |
No description. |
Path |
string |
No description. |
TokenBoundCidrs |
string[] |
No description. |
TokenExplicitMaxTtl |
double |
No description. |
TokenMaxTtl |
double |
No description. |
TokenNoDefaultPolicy |
object |
No description. |
TokenNumUses |
double |
No description. |
TokenPeriod |
double |
No description. |
TokenPolicies |
string[] |
No description. |
TokenTtl |
double |
No description. |
TokenType |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public System.Collections.Generic.IDictionary<string, string> BoundAttributesInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string BoundAttributesTypeInput { get; }
- Type: string
public string[] BoundSubjectsInput { get; }
- Type: string[]
public string BoundSubjectsTypeInput { get; }
- Type: string
public string GroupsAttributeInput { get; }
- Type: string
public string IdInput { get; }
- Type: string
public string NameInput { get; }
- Type: string
public string NamespaceInput { get; }
- Type: string
public string PathInput { get; }
- Type: string
public string[] TokenBoundCidrsInput { get; }
- Type: string[]
public double TokenExplicitMaxTtlInput { get; }
- Type: double
public double TokenMaxTtlInput { get; }
- Type: double
public object TokenNoDefaultPolicyInput { get; }
- Type: object
public double TokenNumUsesInput { get; }
- Type: double
public double TokenPeriodInput { get; }
- Type: double
public string[] TokenPoliciesInput { get; }
- Type: string[]
public double TokenTtlInput { get; }
- Type: double
public string TokenTypeInput { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> BoundAttributes { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string BoundAttributesType { get; }
- Type: string
public string[] BoundSubjects { get; }
- Type: string[]
public string BoundSubjectsType { get; }
- Type: string
public string GroupsAttribute { get; }
- Type: string
public string Id { get; }
- Type: string
public string Name { get; }
- Type: string
public string Namespace { get; }
- Type: string
public string Path { get; }
- Type: string
public string[] TokenBoundCidrs { get; }
- Type: string[]
public double TokenExplicitMaxTtl { get; }
- Type: double
public double TokenMaxTtl { get; }
- Type: double
public object TokenNoDefaultPolicy { get; }
- Type: object
public double TokenNumUses { get; }
- Type: double
public double TokenPeriod { get; }
- Type: double
public string[] TokenPolicies { get; }
- Type: string[]
public double TokenTtl { get; }
- Type: double
public string TokenType { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Vault;
new SamlAuthBackendRoleConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Name,
string Path,
System.Collections.Generic.IDictionary<string, string> BoundAttributes = null,
string BoundAttributesType = null,
string[] BoundSubjects = null,
string BoundSubjectsType = null,
string GroupsAttribute = null,
string Id = null,
string Namespace = null,
string[] TokenBoundCidrs = null,
double TokenExplicitMaxTtl = null,
double TokenMaxTtl = null,
object TokenNoDefaultPolicy = null,
double TokenNumUses = null,
double TokenPeriod = null,
string[] TokenPolicies = null,
double TokenTtl = null,
string TokenType = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
Name |
string |
Unique name of the role. |
Path |
string |
Path where SAML Auth engine is mounted. |
BoundAttributes |
System.Collections.Generic.IDictionary<string, string> |
Mapping of attribute names to values that are expected to exist in the SAML assertion. |
BoundAttributesType |
string |
The type of matching assertion to perform on bound_attributes. |
BoundSubjects |
string[] |
The subject being asserted for SAML authentication. |
BoundSubjectsType |
string |
The type of matching assertion to perform on bound_subjects. |
GroupsAttribute |
string |
The attribute to use to identify the set of groups to which the user belongs. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#id SamlAuthBackendRole#id}. |
Namespace |
string |
Target namespace. (requires Enterprise). |
TokenBoundCidrs |
string[] |
Specifies the blocks of IP addresses which are allowed to use the generated token. |
TokenExplicitMaxTtl |
double |
Generated Token's Explicit Maximum TTL in seconds. |
TokenMaxTtl |
double |
The maximum lifetime of the generated token. |
TokenNoDefaultPolicy |
object |
If true, the 'default' policy will not automatically be added to generated tokens. |
TokenNumUses |
double |
The maximum number of times a token may be used, a value of zero means unlimited. |
TokenPeriod |
double |
Generated Token's Period. |
TokenPolicies |
string[] |
Generated Token's Policies. |
TokenTtl |
double |
The initial ttl of the token to generate in seconds. |
TokenType |
string |
The type of token to generate, service or batch. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Name { get; set; }
- Type: string
Unique name of the role.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#name SamlAuthBackendRole#name}
public string Path { get; set; }
- Type: string
Path where SAML Auth engine is mounted.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#path SamlAuthBackendRole#path}
public System.Collections.Generic.IDictionary<string, string> BoundAttributes { get; set; }
- Type: System.Collections.Generic.IDictionary<string, string>
Mapping of attribute names to values that are expected to exist in the SAML assertion.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#bound_attributes SamlAuthBackendRole#bound_attributes}
public string BoundAttributesType { get; set; }
- Type: string
The type of matching assertion to perform on bound_attributes.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#bound_attributes_type SamlAuthBackendRole#bound_attributes_type}
public string[] BoundSubjects { get; set; }
- Type: string[]
The subject being asserted for SAML authentication.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#bound_subjects SamlAuthBackendRole#bound_subjects}
public string BoundSubjectsType { get; set; }
- Type: string
The type of matching assertion to perform on bound_subjects.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#bound_subjects_type SamlAuthBackendRole#bound_subjects_type}
public string GroupsAttribute { get; set; }
- Type: string
The attribute to use to identify the set of groups to which the user belongs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#groups_attribute SamlAuthBackendRole#groups_attribute}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#id SamlAuthBackendRole#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.
public string Namespace { get; set; }
- Type: 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_role#namespace SamlAuthBackendRole#namespace}
public string[] TokenBoundCidrs { get; set; }
- Type: string[]
Specifies the blocks of IP addresses which are allowed to use the generated token.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_bound_cidrs SamlAuthBackendRole#token_bound_cidrs}
public double TokenExplicitMaxTtl { get; set; }
- Type: double
Generated Token's Explicit Maximum TTL in seconds.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_explicit_max_ttl SamlAuthBackendRole#token_explicit_max_ttl}
public double TokenMaxTtl { get; set; }
- Type: double
The maximum lifetime of the generated token.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_max_ttl SamlAuthBackendRole#token_max_ttl}
public object TokenNoDefaultPolicy { get; set; }
- Type: object
If true, the 'default' policy will not automatically be added to generated tokens.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_no_default_policy SamlAuthBackendRole#token_no_default_policy}
public double TokenNumUses { get; set; }
- Type: double
The maximum number of times a token may be used, a value of zero means unlimited.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_num_uses SamlAuthBackendRole#token_num_uses}
public double TokenPeriod { get; set; }
- Type: double
Generated Token's Period.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_period SamlAuthBackendRole#token_period}
public string[] TokenPolicies { get; set; }
- Type: string[]
Generated Token's Policies.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_policies SamlAuthBackendRole#token_policies}
public double TokenTtl { get; set; }
- Type: double
The initial ttl of the token to generate in seconds.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_ttl SamlAuthBackendRole#token_ttl}
public string TokenType { get; set; }
- Type: string
The type of token to generate, service or batch.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs/resources/saml_auth_backend_role#token_type SamlAuthBackendRole#token_type}