Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1 kubernetes_secret_v1}.
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1(
scope: Construct,
id: str,
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
metadata: DataKubernetesSecretV1Metadata,
binary_data: typing.Mapping[str] = None,
id: str = None
)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
str |
The scoped construct ID. |
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
metadata |
DataKubernetesSecretV1Metadata |
metadata block. |
binary_data |
typing.Mapping[str] |
A map of the secret data with values encoded in base64 format. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#id DataKubernetesSecretV1#id}. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
- Type: typing.List[cdktf.ITerraformDependable]
- Type: cdktf.ITerraformIterator
- Type: cdktf.TerraformResourceLifecycle
- Type: cdktf.TerraformProvider
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
metadata block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#metadata DataKubernetesSecretV1#metadata}
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#binary_data DataKubernetesSecretV1#binary_data}
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#id DataKubernetesSecretV1#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.
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
add_override |
No description. |
override_logical_id |
Overrides the auto-generated logical ID with a specific ID. |
reset_override_logical_id |
Resets a previously passed logical Id to use the auto-generated logical id again. |
to_hcl_terraform |
Adds this resource to the terraform JSON output. |
to_metadata |
No description. |
to_terraform |
Adds this resource to the terraform JSON output. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
put_metadata |
No description. |
reset_binary_data |
No description. |
reset_id |
No description. |
def to_string() -> str
Returns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def put_metadata(
annotations: typing.Mapping[str] = None,
generate_name: str = None,
labels: typing.Mapping[str] = None,
name: str = None,
namespace: str = None
) -> None
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#annotations DataKubernetesSecretV1#annotations}
- Type: str
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/data-sources/secret_v1#generate_name DataKubernetesSecretV1#generate_name}
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#labels DataKubernetesSecretV1#labels}
- Type: str
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.35.1/docs/data-sources/secret_v1#name DataKubernetesSecretV1#name}
- Type: str
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.35.1/docs/data-sources/secret_v1#namespace DataKubernetesSecretV1#namespace}
def reset_binary_data() -> None
def reset_id() -> None
Name | Description |
---|---|
is_construct |
Checks if x is a construct. |
is_terraform_element |
No description. |
is_terraform_data_source |
No description. |
generate_config_for_import |
Generates CDKTF code for importing a DataKubernetesSecretV1 resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1.is_construct(
x: typing.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: typing.Any
Any object.
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1.is_terraform_data_source(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a DataKubernetesSecretV1 resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the DataKubernetesSecretV1 to import.
- Type: str
The id of the existing DataKubernetesSecretV1 that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DataKubernetesSecretV1 to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktf.TerraformStack |
No description. |
fqn |
str |
No description. |
friendly_unique_id |
str |
No description. |
terraform_meta_arguments |
typing.Mapping[typing.Any] |
No description. |
terraform_resource_type |
str |
No description. |
terraform_generator_metadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[str] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
data |
cdktf.StringMap |
No description. |
immutable |
cdktf.IResolvable |
No description. |
metadata |
DataKubernetesSecretV1MetadataOutputReference |
No description. |
type |
str |
No description. |
binary_data_input |
typing.Mapping[str] |
No description. |
id_input |
str |
No description. |
metadata_input |
DataKubernetesSecretV1Metadata |
No description. |
binary_data |
typing.Mapping[str] |
No description. |
id |
str |
No description. |
node: Node
- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack
- Type: cdktf.TerraformStack
fqn: str
- Type: str
friendly_unique_id: str
- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
- Type: cdktf.TerraformProviderGeneratorMetadata
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[str]
- Type: typing.List[str]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
data: StringMap
- Type: cdktf.StringMap
immutable: IResolvable
- Type: cdktf.IResolvable
metadata: DataKubernetesSecretV1MetadataOutputReference
type: str
- Type: str
binary_data_input: typing.Mapping[str]
- Type: typing.Mapping[str]
id_input: str
- Type: str
metadata_input: DataKubernetesSecretV1Metadata
binary_data: typing.Mapping[str]
- Type: typing.Mapping[str]
id: str
- Type: str
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1Config(
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
metadata: DataKubernetesSecretV1Metadata,
binary_data: typing.Mapping[str] = None,
id: str = None
)
Name | Type | Description |
---|---|---|
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
metadata |
DataKubernetesSecretV1Metadata |
metadata block. |
binary_data |
typing.Mapping[str] |
A map of the secret data with values encoded in base64 format. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#id DataKubernetesSecretV1#id}. |
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[ITerraformDependable]
- Type: typing.List[cdktf.ITerraformDependable]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
metadata: DataKubernetesSecretV1Metadata
metadata block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#metadata DataKubernetesSecretV1#metadata}
binary_data: typing.Mapping[str]
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#binary_data DataKubernetesSecretV1#binary_data}
id: str
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs/data-sources/secret_v1#id DataKubernetesSecretV1#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.
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1Metadata(
annotations: typing.Mapping[str] = None,
generate_name: str = None,
labels: typing.Mapping[str] = None,
name: str = None,
namespace: str = None
)
Name | Type | Description |
---|---|---|
annotations |
typing.Mapping[str] |
An unstructured key value map stored with the secret that may be used to store arbitrary metadata. |
generate_name |
str |
Prefix, used by the server, to generate a unique name ONLY IF the name field has not been provided. |
labels |
typing.Mapping[str] |
Map of string keys and values that can be used to organize and categorize (scope and select) the secret. |
name |
str |
Name of the secret, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names. |
namespace |
str |
Namespace defines the space within which name of the secret must be unique. |
annotations: typing.Mapping[str]
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#annotations DataKubernetesSecretV1#annotations}
generate_name: str
- Type: str
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/data-sources/secret_v1#generate_name DataKubernetesSecretV1#generate_name}
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
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.35.1/docs/data-sources/secret_v1#labels DataKubernetesSecretV1#labels}
name: str
- Type: str
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.35.1/docs/data-sources/secret_v1#name DataKubernetesSecretV1#name}
namespace: str
- Type: str
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.35.1/docs/data-sources/secret_v1#namespace DataKubernetesSecretV1#namespace}
from cdktf_cdktf_provider_kubernetes import data_kubernetes_secret_v1
dataKubernetesSecretV1.DataKubernetesSecretV1MetadataOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
reset_annotations |
No description. |
reset_generate_name |
No description. |
reset_labels |
No description. |
reset_name |
No description. |
reset_namespace |
No description. |
def compute_fqn() -> str
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable
- Type: str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def reset_annotations() -> None
def reset_generate_name() -> None
def reset_labels() -> None
def reset_name() -> None
def reset_namespace() -> None
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
generation |
typing.Union[int, float] |
No description. |
resource_version |
str |
No description. |
uid |
str |
No description. |
annotations_input |
typing.Mapping[str] |
No description. |
generate_name_input |
str |
No description. |
labels_input |
typing.Mapping[str] |
No description. |
name_input |
str |
No description. |
namespace_input |
str |
No description. |
annotations |
typing.Mapping[str] |
No description. |
generate_name |
str |
No description. |
labels |
typing.Mapping[str] |
No description. |
name |
str |
No description. |
namespace |
str |
No description. |
internal_value |
DataKubernetesSecretV1Metadata |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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.
fqn: str
- Type: str
generation: typing.Union[int, float]
- Type: typing.Union[int, float]
resource_version: str
- Type: str
uid: str
- Type: str
annotations_input: typing.Mapping[str]
- Type: typing.Mapping[str]
generate_name_input: str
- Type: str
labels_input: typing.Mapping[str]
- Type: typing.Mapping[str]
name_input: str
- Type: str
namespace_input: str
- Type: str
annotations: typing.Mapping[str]
- Type: typing.Mapping[str]
generate_name: str
- Type: str
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
name: str
- Type: str
namespace: str
- Type: str
internal_value: DataKubernetesSecretV1Metadata