Skip to content

Latest commit

 

History

History
1351 lines (842 loc) · 60.3 KB

dataKubernetesSecret.go.md

File metadata and controls

1351 lines (842 loc) · 60.3 KB

dataKubernetesSecret Submodule

Constructs

DataKubernetesSecret

Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/data-sources/secret kubernetes_secret}.

Initializers

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

datakubernetessecret.NewDataKubernetesSecret(scope Construct, id *string, config DataKubernetesSecretConfig) DataKubernetesSecret
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 DataKubernetesSecretConfig 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.
ResetBinaryData No description.
ResetId 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 DataKubernetesSecretMetadata)
valueRequired

ResetBinaryData
func ResetBinaryData()
ResetId
func ResetId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataKubernetesSecret resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

datakubernetessecret.DataKubernetesSecret_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/v11/datakubernetessecret"

datakubernetessecret.DataKubernetesSecret_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformDataSource
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

datakubernetessecret.DataKubernetesSecret_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

datakubernetessecret.DataKubernetesSecret_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a DataKubernetesSecret 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 DataKubernetesSecret to import.


importFromIdRequired
  • Type: *string

The id of the existing DataKubernetesSecret that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/data-sources/secret#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 DataKubernetesSecret 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.
Data github.com/hashicorp/terraform-cdk-go/cdktf.StringMap No description.
Immutable github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
Metadata DataKubernetesSecretMetadataOutputReference No description.
Type *string No description.
BinaryDataInput *map[string]*string No description.
IdInput *string No description.
MetadataInput DataKubernetesSecretMetadata No description.
BinaryData *map[string]*string No description.
Id *string 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

DataRequired
func Data() StringMap
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

ImmutableRequired
func Immutable() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable

MetadataRequired
func Metadata() DataKubernetesSecretMetadataOutputReference

TypeRequired
func Type() *string
  • Type: *string

BinaryDataInputOptional
func BinaryDataInput() *map[string]*string
  • Type: *map[string]*string

IdInputOptional
func IdInput() *string
  • Type: *string

MetadataInputOptional
func MetadataInput() DataKubernetesSecretMetadata

BinaryDataRequired
func BinaryData() *map[string]*string
  • Type: *map[string]*string

IdRequired
func Id() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

DataKubernetesSecretConfig

Initializer

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

&datakubernetessecret.DataKubernetesSecretConfig {
	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{},
	Metadata: github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11.dataKubernetesSecret.DataKubernetesSecretMetadata,
	BinaryData: *map[string]*string,
	Id: *string,
}

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.
Metadata DataKubernetesSecretMetadata metadata block.
BinaryData *map[string]*string A map of the secret data with values encoded in base64 format.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/data-sources/secret#id DataKubernetesSecret#id}.

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

MetadataRequired
Metadata DataKubernetesSecretMetadata

metadata block.

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


BinaryDataOptional
BinaryData *map[string]*string
  • Type: *map[string]*string

A map of the secret data with values encoded in base64 format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/data-sources/secret#binary_data DataKubernetesSecret#binary_data}


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs/data-sources/secret#id DataKubernetesSecret#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.


DataKubernetesSecretMetadata

Initializer

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

&datakubernetessecret.DataKubernetesSecretMetadata {
	Annotations: *map[string]*string,
	GenerateName: *string,
	Labels: *map[string]*string,
	Name: *string,
	Namespace: *string,
}

Properties

Name Type Description
Annotations *map[string]*string An unstructured key value map stored with the secret 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 *map[string]*string Map of string keys and values that can be used to organize and categorize (scope and select) the secret.
Name *string Name of the secret, 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 secret must be unique.

AnnotationsOptional
Annotations *map[string]*string
  • Type: *map[string]*string

An unstructured key value map stored with the secret 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/data-sources/secret#annotations DataKubernetesSecret#annotations}


GenerateNameOptional
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.30.0/docs/data-sources/secret#generate_name DataKubernetesSecret#generate_name}


LabelsOptional
Labels *map[string]*string
  • Type: *map[string]*string

Map of string keys and values that can be used to organize and categorize (scope and select) the secret.

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/data-sources/secret#labels DataKubernetesSecret#labels}


NameOptional
Name *string
  • Type: *string

Name of the secret, 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/data-sources/secret#name DataKubernetesSecret#name}


NamespaceOptional
Namespace *string
  • Type: *string

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

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


Classes

DataKubernetesSecretMetadataOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-kubernetes-go/kubernetes/v11/datakubernetessecret"

datakubernetessecret.NewDataKubernetesSecretMetadataOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DataKubernetesSecretMetadataOutputReference
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.
ResetAnnotations No description.
ResetGenerateName No description.
ResetLabels No description.
ResetName No description.
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.

ResetAnnotations
func ResetAnnotations()
ResetGenerateName
func ResetGenerateName()
ResetLabels
func ResetLabels()
ResetName
func ResetName()
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.
Generation *f64 No description.
ResourceVersion *string No description.
Uid *string No description.
AnnotationsInput *map[string]*string No description.
GenerateNameInput *string No description.
LabelsInput *map[string]*string No description.
NameInput *string No description.
NamespaceInput *string No description.
Annotations *map[string]*string No description.
GenerateName *string No description.
Labels *map[string]*string No description.
Name *string No description.
Namespace *string No description.
InternalValue DataKubernetesSecretMetadata 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

GenerationRequired
func Generation() *f64
  • Type: *f64

ResourceVersionRequired
func ResourceVersion() *string
  • Type: *string

UidRequired
func Uid() *string
  • Type: *string

AnnotationsInputOptional
func AnnotationsInput() *map[string]*string
  • Type: *map[string]*string

GenerateNameInputOptional
func GenerateNameInput() *string
  • Type: *string

LabelsInputOptional
func LabelsInput() *map[string]*string
  • Type: *map[string]*string

NameInputOptional
func NameInput() *string
  • Type: *string

NamespaceInputOptional
func NamespaceInput() *string
  • Type: *string

AnnotationsRequired
func Annotations() *map[string]*string
  • Type: *map[string]*string

GenerateNameRequired
func GenerateName() *string
  • Type: *string

LabelsRequired
func Labels() *map[string]*string
  • Type: *map[string]*string

NameRequired
func Name() *string
  • Type: *string

NamespaceRequired
func Namespace() *string
  • Type: *string

InternalValueOptional
func InternalValue() DataKubernetesSecretMetadata