Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver kubernetes_csi_driver}.
import { csiDriver } from '@cdktf/provider-kubernetes'
new csiDriver.CsiDriver(scope: Construct, id: string, config: CsiDriverConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
CsiDriverConfig |
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: CsiDriverConfig
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". |
putMetadata |
No description. |
putSpec |
No description. |
resetId |
No description. |
resetSpec |
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 putMetadata(value: CsiDriverMetadata): void
- Type: CsiDriverMetadata
public putSpec(value: CsiDriverSpec): void
- Type: CsiDriverSpec
public resetId(): void
public resetSpec(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a CsiDriver resource upon running "cdktf plan ". |
import { csiDriver } from '@cdktf/provider-kubernetes'
csiDriver.CsiDriver.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 { csiDriver } from '@cdktf/provider-kubernetes'
csiDriver.CsiDriver.isTerraformElement(x: any)
- Type: any
import { csiDriver } from '@cdktf/provider-kubernetes'
csiDriver.CsiDriver.isTerraformResource(x: any)
- Type: any
import { csiDriver } from '@cdktf/provider-kubernetes'
csiDriver.CsiDriver.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a CsiDriver 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 CsiDriver to import.
- Type: string
The id of the existing CsiDriver that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the CsiDriver 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. |
metadata |
CsiDriverMetadataOutputReference |
No description. |
spec |
CsiDriverSpecOutputReference |
No description. |
idInput |
string |
No description. |
metadataInput |
CsiDriverMetadata |
No description. |
specInput |
CsiDriverSpec |
No description. |
id |
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 metadata: CsiDriverMetadataOutputReference;
public readonly spec: CsiDriverSpecOutputReference;
public readonly idInput: string;
- Type: string
public readonly metadataInput: CsiDriverMetadata;
- Type: CsiDriverMetadata
public readonly specInput: CsiDriverSpec;
- Type: CsiDriverSpec
public readonly id: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { csiDriver } from '@cdktf/provider-kubernetes'
const csiDriverConfig: csiDriver.CsiDriverConfig = { ... }
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. |
metadata |
CsiDriverMetadata |
metadata block. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#id CsiDriver#id}. |
spec |
CsiDriverSpec |
spec block. |
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 metadata: CsiDriverMetadata;
- Type: CsiDriverMetadata
metadata block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#metadata CsiDriver#metadata}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#id CsiDriver#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 spec: CsiDriverSpec;
- Type: CsiDriverSpec
spec block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#spec CsiDriver#spec}
import { csiDriver } from '@cdktf/provider-kubernetes'
const csiDriverMetadata: csiDriver.CsiDriverMetadata = { ... }
Name | Type | Description |
---|---|---|
annotations |
{[ key: string ]: string} |
An unstructured key value map stored with the csi driver that may be used to store arbitrary metadata. |
generateName |
string |
Prefix, used by the server, to generate a unique name ONLY IF the name field has not been provided. |
labels |
{[ key: string ]: string} |
Map of string keys and values that can be used to organize and categorize (scope and select) the csi driver. |
name |
string |
Name of the csi driver, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names. |
public readonly annotations: {[ key: string ]: string};
- Type: {[ key: string ]: string}
An unstructured key value map stored with the csi driver that may be used to store arbitrary metadata.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#annotations CsiDriver#annotations}
public readonly generateName: string;
- Type: string
Prefix, used by the server, to generate a unique name ONLY IF the name
field has not been provided.
This value will also be combined with a unique suffix. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#idempotency
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#generate_name CsiDriver#generate_name}
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Map of string keys and values that can be used to organize and categorize (scope and select) the csi driver.
May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#labels CsiDriver#labels}
public readonly name: string;
- Type: string
Name of the csi driver, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#name CsiDriver#name}
import { csiDriver } from '@cdktf/provider-kubernetes'
const csiDriverSpec: csiDriver.CsiDriverSpec = { ... }
Name | Type | Description |
---|---|---|
attachRequired |
boolean | cdktf.IResolvable |
Indicates if the CSI volume driver requires an attach operation. |
podInfoOnMount |
boolean | cdktf.IResolvable |
Indicates that the CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. |
volumeLifecycleModes |
string[] |
Defines what kind of volumes this CSI volume driver supports. |
public readonly attachRequired: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Indicates if the CSI volume driver requires an attach operation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#attach_required CsiDriver#attach_required}
public readonly podInfoOnMount: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Indicates that the CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#pod_info_on_mount CsiDriver#pod_info_on_mount}
public readonly volumeLifecycleModes: string[];
- Type: string[]
Defines what kind of volumes this CSI volume driver supports.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/csi_driver#volume_lifecycle_modes CsiDriver#volume_lifecycle_modes}
import { csiDriver } from '@cdktf/provider-kubernetes'
new csiDriver.CsiDriverMetadataOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
computeFqn |
No description. |
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. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetAnnotations |
No description. |
resetGenerateName |
No description. |
resetLabels |
No description. |
resetName |
No description. |
public computeFqn(): string
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 interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetAnnotations(): void
public resetGenerateName(): void
public resetLabels(): void
public resetName(): void
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
generation |
number |
No description. |
resourceVersion |
string |
No description. |
uid |
string |
No description. |
annotationsInput |
{[ key: string ]: string} |
No description. |
generateNameInput |
string |
No description. |
labelsInput |
{[ key: string ]: string} |
No description. |
nameInput |
string |
No description. |
annotations |
{[ key: string ]: string} |
No description. |
generateName |
string |
No description. |
labels |
{[ key: string ]: string} |
No description. |
name |
string |
No description. |
internalValue |
CsiDriverMetadata |
No description. |
public readonly creationStack: string[];
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;
- Type: string
public readonly generation: number;
- Type: number
public readonly resourceVersion: string;
- Type: string
public readonly uid: string;
- Type: string
public readonly annotationsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly generateNameInput: string;
- Type: string
public readonly labelsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly nameInput: string;
- Type: string
public readonly annotations: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly generateName: string;
- Type: string
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly name: string;
- Type: string
public readonly internalValue: CsiDriverMetadata;
- Type: CsiDriverMetadata
import { csiDriver } from '@cdktf/provider-kubernetes'
new csiDriver.CsiDriverSpecOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
computeFqn |
No description. |
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. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetPodInfoOnMount |
No description. |
resetVolumeLifecycleModes |
No description. |
public computeFqn(): string
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 interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetPodInfoOnMount(): void
public resetVolumeLifecycleModes(): void
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
attachRequiredInput |
boolean | cdktf.IResolvable |
No description. |
podInfoOnMountInput |
boolean | cdktf.IResolvable |
No description. |
volumeLifecycleModesInput |
string[] |
No description. |
attachRequired |
boolean | cdktf.IResolvable |
No description. |
podInfoOnMount |
boolean | cdktf.IResolvable |
No description. |
volumeLifecycleModes |
string[] |
No description. |
internalValue |
CsiDriverSpec |
No description. |
public readonly creationStack: string[];
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;
- Type: string
public readonly attachRequiredInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly podInfoOnMountInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly volumeLifecycleModesInput: string[];
- Type: string[]
public readonly attachRequired: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly podInfoOnMount: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly volumeLifecycleModes: string[];
- Type: string[]
public readonly internalValue: CsiDriverSpec;
- Type: CsiDriverSpec