# KubernetesDeploymentScale

> Resource KubernetesDeploymentScale in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Resource KubernetesDeploymentScale in pulumi-portainer.

Pulumi type: `portainer:index/kubernetesDeploymentScale:KubernetesDeploymentScale`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const resource = new portainer.KubernetesDeploymentScale(
  "kubernetesDeploymentScale",
  {
    deploymentName: "<deploymentName>",
    environmentId: 0,
    namespace: "<namespace>",
    replicas: 0,
  },
)
```

## Arguments

| Property                      | Type     | Required | Description                                                                                                       |
| ----------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `deploymentName`              | `string` | yes      | Name of the deployment to scale. The deployment must already exist; this resource manages only its replica count. |
| `environmentId`               | `number` | yes      | Identifier of the Portainer Kubernetes environment the deployment belongs to.                                     |
| `kubernetesDeploymentScaleId` | `string` | no       |                                                                                                                   |
| `namespace`                   | `string` | yes      | Namespace the deployment lives in.                                                                                |
| `replicas`                    | `number` | yes      | Desired number of replicas. Changing this scales the deployment in place.                                         |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property                      | Type     | Computed | Description                                                                                                          |
| ----------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `availableReplicas`           | `number` | yes      | Number of replicas available for at least the configured minimum ready seconds, as reported after the scale request. |
| `deploymentName`              | `string` | no       | Name of the deployment to scale. The deployment must already exist; this resource manages only its replica count.    |
| `environmentId`               | `number` | no       | Identifier of the Portainer Kubernetes environment the deployment belongs to.                                        |
| `kubernetesDeploymentScaleId` | `string` | no       |                                                                                                                      |
| `namespace`                   | `string` | no       | Namespace the deployment lives in.                                                                                   |
| `readyReplicas`               | `number` | yes      | Number of replicas passing their readiness checks, as reported after the scale request.                              |
| `replicas`                    | `number` | no       | Desired number of replicas. Changing this scales the deployment in place.                                            |