Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster upcloud_kubernetes_cluster}.
from cdktf_cdktf_provider_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesCluster(
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,
control_plane_ip_filter: typing.List[str],
name: str,
network: str,
zone: str,
labels: typing.Mapping[str] = None,
plan: str = None,
private_node_groups: typing.Union[bool, IResolvable] = None,
storage_encryption: str = None,
version: 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. |
control_plane_ip_filter |
typing.List[str] |
IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane. |
name |
str |
Cluster name. Needs to be unique within the account. |
network |
str |
Network ID for the cluster to run in. |
zone |
str |
Zone in which the Kubernetes cluster will be hosted, e.g. de-fra1 . You can list available zones with upctl zone list . |
labels |
typing.Mapping[str] |
User defined key-value pairs to classify the cluster. |
plan |
str |
The pricing plan used for the cluster. |
private_node_groups |
typing.Union[bool, cdktf.IResolvable] |
Enable private node groups. Private node groups requires a network that is routed through NAT gateway. |
storage_encryption |
str |
Set default storage encryption strategy for all nodes in the cluster. |
version |
str |
Kubernetes version ID, e.g. 1.29 . You can list available version IDs with upctl kubernetes versions . |
- 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]]
- Type: typing.List[str]
IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane.
To allow access from any source, use ["0.0.0.0/0"]
. To deny access from all sources, use []
. Values set here do not restrict access to node groups or exposed Kubernetes services.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#control_plane_ip_filter KubernetesCluster#control_plane_ip_filter}
- Type: str
Cluster name. Needs to be unique within the account.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#name KubernetesCluster#name}
- Type: str
Network ID for the cluster to run in.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#network KubernetesCluster#network}
- Type: str
Zone in which the Kubernetes cluster will be hosted, e.g. de-fra1
. You can list available zones with upctl zone list
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#zone KubernetesCluster#zone}
- Type: typing.Mapping[str]
User defined key-value pairs to classify the cluster.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#labels KubernetesCluster#labels}
- Type: str
The pricing plan used for the cluster.
Default plan is development
. You can list available plans with upctl kubernetes plans
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#plan KubernetesCluster#plan}
- Type: typing.Union[bool, cdktf.IResolvable]
Enable private node groups. Private node groups requires a network that is routed through NAT gateway.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#private_node_groups KubernetesCluster#private_node_groups}
- Type: str
Set default storage encryption strategy for all nodes in the cluster.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#storage_encryption KubernetesCluster#storage_encryption}
- Type: str
Kubernetes version ID, e.g. 1.29
. You can list available version IDs with upctl kubernetes versions
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#version KubernetesCluster#version}
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 |
No description. |
to_metadata |
No description. |
to_terraform |
Adds this resource to the terraform JSON output. |
add_move_target |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
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. |
has_resource_move |
No description. |
import_from |
No description. |
interpolation_for_attribute |
No description. |
move_from_id |
Move the resource corresponding to "id" to this resource. |
move_to |
Moves this resource to the target resource given by moveTarget. |
move_to_id |
Moves this resource to the resource corresponding to "id". |
reset_labels |
No description. |
reset_plan |
No description. |
reset_private_node_groups |
No description. |
reset_storage_encryption |
No description. |
reset_version |
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
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def add_move_target(
move_target: str
) -> None
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: str
The string move target that will correspond to this resource.
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 has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
def import_from(
id: str,
provider: TerraformProvider = None
) -> None
- Type: str
- Type: cdktf.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def move_from_id(
id: str
) -> None
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: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
def move_to(
move_target: str,
index: typing.Union[str, typing.Union[int, float]] = None
) -> None
Moves this resource to the target resource given by moveTarget.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: typing.Union[str, typing.Union[int, float]]
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
def move_to_id(
id: str
) -> None
Moves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def reset_labels() -> None
def reset_plan() -> None
def reset_private_node_groups() -> None
def reset_storage_encryption() -> None
def reset_version() -> None
Name | Description |
---|---|
is_construct |
Checks if x is a construct. |
is_terraform_element |
No description. |
is_terraform_resource |
No description. |
generate_config_for_import |
Generates CDKTF code for importing a KubernetesCluster resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesCluster.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_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesCluster.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesCluster.is_terraform_resource(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesCluster.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a KubernetesCluster 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 KubernetesCluster to import.
- Type: str
The id of the existing KubernetesCluster that should be imported.
Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the KubernetesCluster 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. |
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
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. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
id |
str |
No description. |
network_cidr |
str |
No description. |
node_groups |
typing.List[str] |
No description. |
state |
str |
No description. |
control_plane_ip_filter_input |
typing.List[str] |
No description. |
labels_input |
typing.Mapping[str] |
No description. |
name_input |
str |
No description. |
network_input |
str |
No description. |
plan_input |
str |
No description. |
private_node_groups_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
storage_encryption_input |
str |
No description. |
version_input |
str |
No description. |
zone_input |
str |
No description. |
control_plane_ip_filter |
typing.List[str] |
No description. |
labels |
typing.Mapping[str] |
No description. |
name |
str |
No description. |
network |
str |
No description. |
plan |
str |
No description. |
private_node_groups |
typing.Union[bool, cdktf.IResolvable] |
No description. |
storage_encryption |
str |
No description. |
version |
str |
No description. |
zone |
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
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[str]
- Type: typing.List[str]
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]]
id: str
- Type: str
network_cidr: str
- Type: str
node_groups: typing.List[str]
- Type: typing.List[str]
state: str
- Type: str
control_plane_ip_filter_input: typing.List[str]
- Type: typing.List[str]
labels_input: typing.Mapping[str]
- Type: typing.Mapping[str]
name_input: str
- Type: str
network_input: str
- Type: str
plan_input: str
- Type: str
private_node_groups_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
storage_encryption_input: str
- Type: str
version_input: str
- Type: str
zone_input: str
- Type: str
control_plane_ip_filter: typing.List[str]
- Type: typing.List[str]
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
name: str
- Type: str
network: str
- Type: str
plan: str
- Type: str
private_node_groups: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
storage_encryption: str
- Type: str
version: str
- Type: str
zone: str
- Type: str
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_upcloud import kubernetes_cluster
kubernetesCluster.KubernetesClusterConfig(
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,
control_plane_ip_filter: typing.List[str],
name: str,
network: str,
zone: str,
labels: typing.Mapping[str] = None,
plan: str = None,
private_node_groups: typing.Union[bool, IResolvable] = None,
storage_encryption: str = None,
version: 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. |
control_plane_ip_filter |
typing.List[str] |
IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane. |
name |
str |
Cluster name. Needs to be unique within the account. |
network |
str |
Network ID for the cluster to run in. |
zone |
str |
Zone in which the Kubernetes cluster will be hosted, e.g. de-fra1 . You can list available zones with upctl zone list . |
labels |
typing.Mapping[str] |
User defined key-value pairs to classify the cluster. |
plan |
str |
The pricing plan used for the cluster. |
private_node_groups |
typing.Union[bool, cdktf.IResolvable] |
Enable private node groups. Private node groups requires a network that is routed through NAT gateway. |
storage_encryption |
str |
Set default storage encryption strategy for all nodes in the cluster. |
version |
str |
Kubernetes version ID, e.g. 1.29 . You can list available version IDs with upctl kubernetes versions . |
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]]
control_plane_ip_filter: typing.List[str]
- Type: typing.List[str]
IP addresses or IP ranges in CIDR format which are allowed to access the cluster control plane.
To allow access from any source, use ["0.0.0.0/0"]
. To deny access from all sources, use []
. Values set here do not restrict access to node groups or exposed Kubernetes services.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#control_plane_ip_filter KubernetesCluster#control_plane_ip_filter}
name: str
- Type: str
Cluster name. Needs to be unique within the account.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#name KubernetesCluster#name}
network: str
- Type: str
Network ID for the cluster to run in.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#network KubernetesCluster#network}
zone: str
- Type: str
Zone in which the Kubernetes cluster will be hosted, e.g. de-fra1
. You can list available zones with upctl zone list
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#zone KubernetesCluster#zone}
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
User defined key-value pairs to classify the cluster.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#labels KubernetesCluster#labels}
plan: str
- Type: str
The pricing plan used for the cluster.
Default plan is development
. You can list available plans with upctl kubernetes plans
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#plan KubernetesCluster#plan}
private_node_groups: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Enable private node groups. Private node groups requires a network that is routed through NAT gateway.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#private_node_groups KubernetesCluster#private_node_groups}
storage_encryption: str
- Type: str
Set default storage encryption strategy for all nodes in the cluster.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#storage_encryption KubernetesCluster#storage_encryption}
version: str
- Type: str
Kubernetes version ID, e.g. 1.29
. You can list available version IDs with upctl kubernetes versions
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/kubernetes_cluster#version KubernetesCluster#version}