Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role vault_azure_auth_backend_role}.
import { azureAuthBackendRole } from '@cdktf/provider-vault'
new azureAuthBackendRole.AzureAuthBackendRole(scope: Construct, id: string, config: AzureAuthBackendRoleConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
AzureAuthBackendRoleConfig |
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". |
resetBackend |
No description. |
resetBoundGroupIds |
No description. |
resetBoundLocations |
No description. |
resetBoundResourceGroups |
No description. |
resetBoundScaleSets |
No description. |
resetBoundServicePrincipalIds |
No description. |
resetBoundSubscriptionIds |
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. |
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 resetBackend(): void
public resetBoundGroupIds(): void
public resetBoundLocations(): void
public resetBoundResourceGroups(): void
public resetBoundScaleSets(): void
public resetBoundServicePrincipalIds(): void
public resetBoundSubscriptionIds(): void
public resetId(): void
public resetNamespace(): void
public resetTokenBoundCidrs(): void
public resetTokenExplicitMaxTtl(): void
public resetTokenMaxTtl(): void
public resetTokenNoDefaultPolicy(): void
public resetTokenNumUses(): void
public resetTokenPeriod(): void
public resetTokenPolicies(): void
public resetTokenTtl(): void
public resetTokenType(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a AzureAuthBackendRole resource upon running "cdktf plan ". |
import { azureAuthBackendRole } from '@cdktf/provider-vault'
azureAuthBackendRole.AzureAuthBackendRole.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 { azureAuthBackendRole } from '@cdktf/provider-vault'
azureAuthBackendRole.AzureAuthBackendRole.isTerraformElement(x: any)
- Type: any
import { azureAuthBackendRole } from '@cdktf/provider-vault'
azureAuthBackendRole.AzureAuthBackendRole.isTerraformResource(x: any)
- Type: any
import { azureAuthBackendRole } from '@cdktf/provider-vault'
azureAuthBackendRole.AzureAuthBackendRole.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a AzureAuthBackendRole 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 AzureAuthBackendRole to import.
- Type: string
The id of the existing AzureAuthBackendRole that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the AzureAuthBackendRole 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. |
backendInput |
string |
No description. |
boundGroupIdsInput |
string[] |
No description. |
boundLocationsInput |
string[] |
No description. |
boundResourceGroupsInput |
string[] |
No description. |
boundScaleSetsInput |
string[] |
No description. |
boundServicePrincipalIdsInput |
string[] |
No description. |
boundSubscriptionIdsInput |
string[] |
No description. |
idInput |
string |
No description. |
namespaceInput |
string |
No description. |
roleInput |
string |
No description. |
tokenBoundCidrsInput |
string[] |
No description. |
tokenExplicitMaxTtlInput |
number |
No description. |
tokenMaxTtlInput |
number |
No description. |
tokenNoDefaultPolicyInput |
boolean | cdktf.IResolvable |
No description. |
tokenNumUsesInput |
number |
No description. |
tokenPeriodInput |
number |
No description. |
tokenPoliciesInput |
string[] |
No description. |
tokenTtlInput |
number |
No description. |
tokenTypeInput |
string |
No description. |
backend |
string |
No description. |
boundGroupIds |
string[] |
No description. |
boundLocations |
string[] |
No description. |
boundResourceGroups |
string[] |
No description. |
boundScaleSets |
string[] |
No description. |
boundServicePrincipalIds |
string[] |
No description. |
boundSubscriptionIds |
string[] |
No description. |
id |
string |
No description. |
namespace |
string |
No description. |
role |
string |
No description. |
tokenBoundCidrs |
string[] |
No description. |
tokenExplicitMaxTtl |
number |
No description. |
tokenMaxTtl |
number |
No description. |
tokenNoDefaultPolicy |
boolean | cdktf.IResolvable |
No description. |
tokenNumUses |
number |
No description. |
tokenPeriod |
number |
No description. |
tokenPolicies |
string[] |
No description. |
tokenTtl |
number |
No description. |
tokenType |
string |
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 backendInput: string;
- Type: string
public readonly boundGroupIdsInput: string[];
- Type: string[]
public readonly boundLocationsInput: string[];
- Type: string[]
public readonly boundResourceGroupsInput: string[];
- Type: string[]
public readonly boundScaleSetsInput: string[];
- Type: string[]
public readonly boundServicePrincipalIdsInput: string[];
- Type: string[]
public readonly boundSubscriptionIdsInput: string[];
- Type: string[]
public readonly idInput: string;
- Type: string
public readonly namespaceInput: string;
- Type: string
public readonly roleInput: string;
- Type: string
public readonly tokenBoundCidrsInput: string[];
- Type: string[]
public readonly tokenExplicitMaxTtlInput: number;
- Type: number
public readonly tokenMaxTtlInput: number;
- Type: number
public readonly tokenNoDefaultPolicyInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly tokenNumUsesInput: number;
- Type: number
public readonly tokenPeriodInput: number;
- Type: number
public readonly tokenPoliciesInput: string[];
- Type: string[]
public readonly tokenTtlInput: number;
- Type: number
public readonly tokenTypeInput: string;
- Type: string
public readonly backend: string;
- Type: string
public readonly boundGroupIds: string[];
- Type: string[]
public readonly boundLocations: string[];
- Type: string[]
public readonly boundResourceGroups: string[];
- Type: string[]
public readonly boundScaleSets: string[];
- Type: string[]
public readonly boundServicePrincipalIds: string[];
- Type: string[]
public readonly boundSubscriptionIds: string[];
- Type: string[]
public readonly id: string;
- Type: string
public readonly namespace: string;
- Type: string
public readonly role: string;
- Type: string
public readonly tokenBoundCidrs: string[];
- Type: string[]
public readonly tokenExplicitMaxTtl: number;
- Type: number
public readonly tokenMaxTtl: number;
- Type: number
public readonly tokenNoDefaultPolicy: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly tokenNumUses: number;
- Type: number
public readonly tokenPeriod: number;
- Type: number
public readonly tokenPolicies: string[];
- Type: string[]
public readonly tokenTtl: number;
- Type: number
public readonly tokenType: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { azureAuthBackendRole } from '@cdktf/provider-vault'
const azureAuthBackendRoleConfig: azureAuthBackendRole.AzureAuthBackendRoleConfig = { ... }
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. |
role |
string |
Name of the role. |
backend |
string |
Unique name of the auth backend to configure. |
boundGroupIds |
string[] |
The list of group ids that login is restricted to. |
boundLocations |
string[] |
The list of locations that login is restricted to. |
boundResourceGroups |
string[] |
The list of resource groups that login is restricted to. |
boundScaleSets |
string[] |
The list of scale set names that the login is restricted to. |
boundServicePrincipalIds |
string[] |
The list of Service Principal IDs that login is restricted to. |
boundSubscriptionIds |
string[] |
The list of subscription IDs that login is restricted to. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#id AzureAuthBackendRole#id}. |
namespace |
string |
Target namespace. (requires Enterprise). |
tokenBoundCidrs |
string[] |
Specifies the blocks of IP addresses which are allowed to use the generated token. |
tokenExplicitMaxTtl |
number |
Generated Token's Explicit Maximum TTL in seconds. |
tokenMaxTtl |
number |
The maximum lifetime of the generated token. |
tokenNoDefaultPolicy |
boolean | cdktf.IResolvable |
If true, the 'default' policy will not automatically be added to generated tokens. |
tokenNumUses |
number |
The maximum number of times a token may be used, a value of zero means unlimited. |
tokenPeriod |
number |
Generated Token's Period. |
tokenPolicies |
string[] |
Generated Token's Policies. |
tokenTtl |
number |
The initial ttl of the token to generate in seconds. |
tokenType |
string |
The type of token to generate, service or batch. |
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 role: string;
- Type: string
Name of the role.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#role AzureAuthBackendRole#role}
public readonly backend: string;
- Type: string
Unique name of the auth backend to configure.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#backend AzureAuthBackendRole#backend}
public readonly boundGroupIds: string[];
- Type: string[]
The list of group ids that login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_group_ids AzureAuthBackendRole#bound_group_ids}
public readonly boundLocations: string[];
- Type: string[]
The list of locations that login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_locations AzureAuthBackendRole#bound_locations}
public readonly boundResourceGroups: string[];
- Type: string[]
The list of resource groups that login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_resource_groups AzureAuthBackendRole#bound_resource_groups}
public readonly boundScaleSets: string[];
- Type: string[]
The list of scale set names that the login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_scale_sets AzureAuthBackendRole#bound_scale_sets}
public readonly boundServicePrincipalIds: string[];
- Type: string[]
The list of Service Principal IDs that login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_service_principal_ids AzureAuthBackendRole#bound_service_principal_ids}
public readonly boundSubscriptionIds: string[];
- Type: string[]
The list of subscription IDs that login is restricted to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#bound_subscription_ids AzureAuthBackendRole#bound_subscription_ids}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#id AzureAuthBackendRole#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 readonly namespace: string;
- Type: string
Target namespace. (requires Enterprise).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#namespace AzureAuthBackendRole#namespace}
public readonly tokenBoundCidrs: string[];
- 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.2.0/docs/resources/azure_auth_backend_role#token_bound_cidrs AzureAuthBackendRole#token_bound_cidrs}
public readonly tokenExplicitMaxTtl: number;
- Type: number
Generated Token's Explicit Maximum TTL in seconds.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_explicit_max_ttl AzureAuthBackendRole#token_explicit_max_ttl}
public readonly tokenMaxTtl: number;
- Type: number
The maximum lifetime of the generated token.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_max_ttl AzureAuthBackendRole#token_max_ttl}
public readonly tokenNoDefaultPolicy: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
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.2.0/docs/resources/azure_auth_backend_role#token_no_default_policy AzureAuthBackendRole#token_no_default_policy}
public readonly tokenNumUses: number;
- Type: number
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.2.0/docs/resources/azure_auth_backend_role#token_num_uses AzureAuthBackendRole#token_num_uses}
public readonly tokenPeriod: number;
- Type: number
Generated Token's Period.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_period AzureAuthBackendRole#token_period}
public readonly tokenPolicies: string[];
- Type: string[]
Generated Token's Policies.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_policies AzureAuthBackendRole#token_policies}
public readonly tokenTtl: number;
- Type: number
The initial ttl of the token to generate in seconds.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_ttl AzureAuthBackendRole#token_ttl}
public readonly tokenType: string;
- Type: string
The type of token to generate, service or batch.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/azure_auth_backend_role#token_type AzureAuthBackendRole#token_type}