Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/resources/config_map kubernetes_config_map}.
using HashiCorp.Cdktf.Providers.Kubernetes;
new ConfigMap(Construct Scope, string Id, ConfigMapConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
ConfigMapConfig |
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: ConfigMapConfig
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. |
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 PutMetadata(ConfigMapMetadata Value)
- Type: ConfigMapMetadata
private void ResetBinaryData()
private void ResetData()
private void ResetId()
private void ResetImmutable()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a ConfigMap resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Kubernetes;
ConfigMap.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.Kubernetes;
ConfigMap.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Kubernetes;
ConfigMap.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Kubernetes;
ConfigMap.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a ConfigMap 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 ConfigMap to import.
- Type: string
The id of the existing ConfigMap that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/resources/config_map#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 ConfigMap 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. |
Metadata |
ConfigMapMetadataOutputReference |
No description. |
BinaryDataInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
DataInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
IdInput |
string |
No description. |
ImmutableInput |
object |
No description. |
MetadataInput |
ConfigMapMetadata |
No description. |
BinaryData |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Data |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Id |
string |
No description. |
Immutable |
object |
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 ConfigMapMetadataOutputReference Metadata { get; }
public System.Collections.Generic.IDictionary<string, string> BinaryDataInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> DataInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string IdInput { get; }
- Type: string
public object ImmutableInput { get; }
- Type: object
public ConfigMapMetadata MetadataInput { get; }
- Type: ConfigMapMetadata
public System.Collections.Generic.IDictionary<string, string> BinaryData { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public System.Collections.Generic.IDictionary<string, string> Data { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Id { get; }
- Type: string
public object Immutable { get; }
- Type: object
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Kubernetes;
new ConfigMapConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
ConfigMapMetadata Metadata,
System.Collections.Generic.IDictionary<string, string> BinaryData = null,
System.Collections.Generic.IDictionary<string, string> Data = null,
string Id = null,
object Immutable = 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. |
Metadata |
ConfigMapMetadata |
metadata block. |
BinaryData |
System.Collections.Generic.IDictionary<string, string> |
BinaryData contains the binary data. |
Data |
System.Collections.Generic.IDictionary<string, string> |
Data contains the configuration data. |
Id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/resources/config_map#id ConfigMap#id}. |
Immutable |
object |
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). |
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 ConfigMapMetadata Metadata { get; set; }
- Type: ConfigMapMetadata
metadata block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/resources/config_map#metadata ConfigMap#metadata}
public System.Collections.Generic.IDictionary<string, string> BinaryData { get; set; }
- Type: System.Collections.Generic.IDictionary<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.30.0/docs/resources/config_map#binary_data ConfigMap#binary_data}
public System.Collections.Generic.IDictionary<string, string> Data { get; set; }
- Type: System.Collections.Generic.IDictionary<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.30.0/docs/resources/config_map#data ConfigMap#data}
public string Id { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/resources/config_map#id ConfigMap#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 object Immutable { get; set; }
- Type: object
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.30.0/docs/resources/config_map#immutable ConfigMap#immutable}
using HashiCorp.Cdktf.Providers.Kubernetes;
new ConfigMapMetadata {
System.Collections.Generic.IDictionary<string, string> Annotations = null,
string GenerateName = null,
System.Collections.Generic.IDictionary<string, string> Labels = null,
string Name = null,
string Namespace = null
};
Name | Type | Description |
---|---|---|
Annotations |
System.Collections.Generic.IDictionary<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 |
System.Collections.Generic.IDictionary<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. |
public System.Collections.Generic.IDictionary<string, string> Annotations { get; set; }
- Type: System.Collections.Generic.IDictionary<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.30.0/docs/resources/config_map#annotations ConfigMap#annotations}
public string GenerateName { get; set; }
- 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.30.0/docs/resources/config_map#generate_name ConfigMap#generate_name}
public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }
- Type: System.Collections.Generic.IDictionary<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.30.0/docs/resources/config_map#labels ConfigMap#labels}
public string Name { get; set; }
- 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.30.0/docs/resources/config_map#name ConfigMap#name}
public string Namespace { get; set; }
- 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.30.0/docs/resources/config_map#namespace ConfigMap#namespace}
using HashiCorp.Cdktf.Providers.Kubernetes;
new ConfigMapMetadataOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name | Type | Description |
---|---|---|
TerraformResource |
HashiCorp.Cdktf.IInterpolatingParent |
The parent resource. |
TerraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
- Type: HashiCorp.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. |
ResetNamespace |
No description. |
private string ComputeFqn()
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 IResolvable InterpolationForAttribute(string Property)
- Type: string
private object Resolve(IResolveContext Context)
Produce the Token's value at resolution time.
- Type: HashiCorp.Cdktf.IResolveContext
private string ToString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
private void ResetAnnotations()
private void ResetGenerateName()
private void ResetLabels()
private void ResetName()
private void ResetNamespace()
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 |
double |
No description. |
ResourceVersion |
string |
No description. |
Uid |
string |
No description. |
AnnotationsInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
GenerateNameInput |
string |
No description. |
LabelsInput |
System.Collections.Generic.IDictionary<string, string> |
No description. |
NameInput |
string |
No description. |
NamespaceInput |
string |
No description. |
Annotations |
System.Collections.Generic.IDictionary<string, string> |
No description. |
GenerateName |
string |
No description. |
Labels |
System.Collections.Generic.IDictionary<string, string> |
No description. |
Name |
string |
No description. |
Namespace |
string |
No description. |
InternalValue |
ConfigMapMetadata |
No description. |
public string[] CreationStack { get; }
- 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 string Fqn { get; }
- Type: string
public double Generation { get; }
- Type: double
public string ResourceVersion { get; }
- Type: string
public string Uid { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> AnnotationsInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string GenerateNameInput { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> LabelsInput { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string NameInput { get; }
- Type: string
public string NamespaceInput { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> Annotations { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string GenerateName { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, string> Labels { get; }
- Type: System.Collections.Generic.IDictionary<string, string>
public string Name { get; }
- Type: string
public string Namespace { get; }
- Type: string
public ConfigMapMetadata InternalValue { get; }
- Type: ConfigMapMetadata