Skip to content
This repository was archived by the owner on Dec 11, 2025. It is now read-only.

dataKubernetesResource.go.md

Latest commit

 

History

History
1167 lines (723 loc) · 52 KB

dataKubernetesResource.go.md

File metadata and controls

1167 lines (723 loc) · 52 KB
Raw

dataKubernetesResource Submodule

Constructs

DataKubernetesResource

Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource kubernetes_resource}.

Initializers 

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.NewDataKubernetesResource(scope Construct, id *string, config DataKubernetesResourceConfig) DataKubernetesResource
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DataKubernetesResourceConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
PutMetadata No description.
ResetObject No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

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

ToHclTerraform 
func ToHclTerraform() interface{}

Adds this resource to the terraform JSON output.

ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
PutMetadata 
func PutMetadata(value DataKubernetesResourceMetadata)
valueRequired
ResetObject 
func ResetObject()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataKubernetesResource resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.DataKubernetesResource_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.DataKubernetesResource_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformDataSource 
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.DataKubernetesResource_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.DataKubernetesResource_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

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

importFromIdRequired
  • Type: *string

The id of the existing DataKubernetesResource that should be imported.

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

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Metadata DataKubernetesResourceMetadataOutputReference No description.
ApiVersionInput *string No description.
KindInput *string No description.
MetadataInput DataKubernetesResourceMetadata No description.
ObjectInput *map[string]interface{} No description.
ApiVersion *string No description.
Kind *string No description.
Object *map[string]interface{} No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
MetadataRequired 
func Metadata() DataKubernetesResourceMetadataOutputReference
ApiVersionInputOptional 
func ApiVersionInput() *string
  • Type: *string
KindInputOptional 
func KindInput() *string
  • Type: *string
MetadataInputOptional 
func MetadataInput() DataKubernetesResourceMetadata
ObjectInputOptional 
func ObjectInput() *map[string]interface{}
  • Type: *map[string]interface{}
ApiVersionRequired 
func ApiVersion() *string
  • Type: *string
KindRequired 
func Kind() *string
  • Type: *string
ObjectRequired 
func Object() *map[string]interface{}
  • Type: *map[string]interface{}

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

DataKubernetesResourceConfig

Initializer 

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

&datakubernetesresource.DataKubernetesResourceConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	ApiVersion: *string,
	Kind: *string,
	Metadata: github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12.dataKubernetesResource.DataKubernetesResourceMetadata,
	Object: *map[string]interface{},
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
ApiVersion *string The resource apiVersion.
Kind *string The resource kind.
Metadata DataKubernetesResourceMetadata metadata block.
Object *map[string]interface{} The response from the API server.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
ApiVersionRequired 
ApiVersion *string
  • Type: *string

The resource apiVersion.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#api_version DataKubernetesResource#api_version}

KindRequired 
Kind *string
  • Type: *string

The resource kind.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#kind DataKubernetesResource#kind}

MetadataRequired 
Metadata DataKubernetesResourceMetadata

metadata block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#metadata DataKubernetesResource#metadata}

ObjectOptional 
Object *map[string]interface{}
  • Type: *map[string]interface{}

The response from the API server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#object DataKubernetesResource#object}

DataKubernetesResourceMetadata

Initializer 

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

&datakubernetesresource.DataKubernetesResourceMetadata {
	Name: *string,
	Namespace: *string,
}

Properties

Name Type Description
Name *string The resource name.
Namespace *string The resource namespace.
NameRequired 
Name *string
  • Type: *string

The resource name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#name DataKubernetesResource#name}

NamespaceOptional 
Namespace *string
  • Type: *string

The resource namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/data-sources/resource#namespace DataKubernetesResource#namespace}

Classes

DataKubernetesResourceMetadataOutputReference

Initializers 

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v12/datakubernetesresource"

datakubernetesresource.NewDataKubernetesResourceMetadataOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DataKubernetesResourceMetadataOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/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.
ResetNamespace No description.
ComputeFqn 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetNamespace 
func ResetNamespace()

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.
NameInput *string No description.
NamespaceInput *string No description.
Name *string No description.
Namespace *string No description.
InternalValue DataKubernetesResourceMetadata No description.
CreationStackRequired 
func 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 
func Fqn() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
NamespaceInputOptional 
func NamespaceInput() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
NamespaceRequired 
func Namespace() *string
  • Type: *string
InternalValueOptional 
func InternalValue() DataKubernetesResourceMetadata