Skip to content

Latest commit

 

History

History
1519 lines (937 loc) · 63.7 KB

configMapV1.typescript.md

File metadata and controls

1519 lines (937 loc) · 63.7 KB

configMapV1 Submodule

Constructs

ConfigMapV1

Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1 kubernetes_config_map_v1}.

Initializers 

import { configMapV1 } from '@cdktf/provider-kubernetes'

new configMapV1.ConfigMapV1(scope: Construct, id: string, config: ConfigMapV1Config)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ConfigMapV1Config No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

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.
resetBinaryData No description.
resetData No description.
resetId No description.
resetImmutable No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
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.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putMetadata 
public putMetadata(value: ConfigMapV1Metadata): void
valueRequired
resetBinaryData 
public resetBinaryData(): void
resetData 
public resetData(): void
resetId 
public resetId(): void
resetImmutable 
public resetImmutable(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a ConfigMapV1 resource upon running "cdktf plan ".
isConstruct 
import { configMapV1 } from '@cdktf/provider-kubernetes'

configMapV1.ConfigMapV1.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { configMapV1 } from '@cdktf/provider-kubernetes'

configMapV1.ConfigMapV1.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { configMapV1 } from '@cdktf/provider-kubernetes'

configMapV1.ConfigMapV1.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { configMapV1 } from '@cdktf/provider-kubernetes'

configMapV1.ConfigMapV1.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ConfigMapV1 resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the ConfigMapV1 to import.

importFromIdRequired
  • Type: string

The id of the existing ConfigMapV1 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the ConfigMapV1 to import is found.

Properties

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 ConfigMapV1MetadataOutputReference No description.
binaryDataInput {[ key: string ]: string} No description.
dataInput {[ key: string ]: string} No description.
idInput string No description.
immutableInput boolean | cdktf.IResolvable No description.
metadataInput ConfigMapV1Metadata No description.
binaryData {[ key: string ]: string} No description.
data {[ key: string ]: string} No description.
id string No description.
immutable boolean | cdktf.IResolvable No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
metadataRequired 
public readonly metadata: ConfigMapV1MetadataOutputReference;
binaryDataInputOptional 
public readonly binaryDataInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
dataInputOptional 
public readonly dataInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
idInputOptional 
public readonly idInput: string;
  • Type: string
immutableInputOptional 
public readonly immutableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
metadataInputOptional 
public readonly metadataInput: ConfigMapV1Metadata;
binaryDataRequired 
public readonly binaryData: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
dataRequired 
public readonly data: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
idRequired 
public readonly id: string;
  • Type: string
immutableRequired 
public readonly immutable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ConfigMapV1Config

Initializer 

import { configMapV1 } from '@cdktf/provider-kubernetes'

const configMapV1Config: configMapV1.ConfigMapV1Config = { ... }

Properties

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 ConfigMapV1Metadata metadata block.
binaryData {[ key: string ]: string} BinaryData contains the binary data.
data {[ key: string ]: string} Data contains the configuration data.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#id ConfigMapV1#id}.
immutable boolean | cdktf.IResolvable Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified).
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
metadataRequired 
public readonly metadata: ConfigMapV1Metadata;

metadata block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#metadata ConfigMapV1#metadata}

binaryDataOptional 
public readonly binaryData: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

BinaryData contains the binary data.

Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. This field only accepts base64-encoded payloads that will be decoded/encoded before being sent/received to/from the apiserver.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#binary_data ConfigMapV1#binary_data}

dataOptional 
public readonly data: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Data contains the configuration data.

Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#data ConfigMapV1#data}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#id ConfigMapV1#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.

immutableOptional 
public readonly immutable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time. Defaulted to nil.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#immutable ConfigMapV1#immutable}

ConfigMapV1Metadata

Initializer 

import { configMapV1 } from '@cdktf/provider-kubernetes'

const configMapV1Metadata: configMapV1.ConfigMapV1Metadata = { ... }

Properties

Name Type Description
annotations {[ key: string ]: string} An unstructured key value map stored with the config map 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 config map.
name string Name of the config map, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names.
namespace string Namespace defines the space within which name of the config map must be unique.
annotationsOptional 
public readonly annotations: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

An unstructured key value map stored with the config map 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/config_map_v1#annotations ConfigMapV1#annotations}

generateNameOptional 
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/config_map_v1#generate_name ConfigMapV1#generate_name}

labelsOptional 
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 config map.

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/config_map_v1#labels ConfigMapV1#labels}

nameOptional 
public readonly name: string;
  • Type: string

Name of the config map, 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/config_map_v1#name ConfigMapV1#name}

namespaceOptional 
public readonly namespace: string;
  • Type: string

Namespace defines the space within which name of the config map must be unique.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/resources/config_map_v1#namespace ConfigMapV1#namespace}

Classes

ConfigMapV1MetadataOutputReference

Initializers 

import { configMapV1 } from '@cdktf/provider-kubernetes'

new configMapV1.ConfigMapV1MetadataOutputReference(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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

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.
resetNamespace No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAnnotations 
public resetAnnotations(): void
resetGenerateName 
public resetGenerateName(): void
resetLabels 
public resetLabels(): void
resetName 
public resetName(): void
resetNamespace 
public resetNamespace(): void

Properties

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.
namespaceInput string No description.
annotations {[ key: string ]: string} No description.
generateName string No description.
labels {[ key: string ]: string} No description.
name string No description.
namespace string No description.
internalValue ConfigMapV1Metadata No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
generationRequired 
public readonly generation: number;
  • Type: number
resourceVersionRequired 
public readonly resourceVersion: string;
  • Type: string
uidRequired 
public readonly uid: string;
  • Type: string
annotationsInputOptional 
public readonly annotationsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
generateNameInputOptional 
public readonly generateNameInput: string;
  • Type: string
labelsInputOptional 
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
nameInputOptional 
public readonly nameInput: string;
  • Type: string
namespaceInputOptional 
public readonly namespaceInput: string;
  • Type: string
annotationsRequired 
public readonly annotations: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
generateNameRequired 
public readonly generateName: string;
  • Type: string
labelsRequired 
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
nameRequired 
public readonly name: string;
  • Type: string
namespaceRequired 
public readonly namespace: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ConfigMapV1Metadata;