Kubernetes v4.18.3, Oct 31 24

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

kubernetes.policy/v1beta1.PodDisruptionBudget

Explore with Pulumi AI

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

Create PodDisruptionBudget Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PodDisruptionBudget(name: string, args?: PodDisruptionBudget, opts?: CustomResourceOptions);

@overload
def PodDisruptionBudget(resource_name: str,
                        args: Optional[PodDisruptionBudgetInitArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def PodDisruptionBudget(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        metadata: Optional[_meta.v1.ObjectMetaArgs] = None,
                        spec: Optional[PodDisruptionBudgetSpecArgs] = None)

func NewPodDisruptionBudget(ctx *Context, name string, args *PodDisruptionBudgetArgs, opts ...ResourceOption) (*PodDisruptionBudget, error)

public PodDisruptionBudget(string name, PodDisruptionBudgetArgs? args = null, CustomResourceOptions? opts = null)

public PodDisruptionBudget(String name, PodDisruptionBudgetArgs args)
public PodDisruptionBudget(String name, PodDisruptionBudgetArgs args, CustomResourceOptions options)

type: kubernetes:policy/v1beta1:PodDisruptionBudget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PodDisruptionBudget: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PodDisruptionBudgetInitArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PodDisruptionBudgetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PodDisruptionBudgetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PodDisruptionBudgetArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

PodDisruptionBudget Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PodDisruptionBudget resource accepts the following input properties:

Metadata Pulumi.Kubernetes.Meta.V1.Inputs.ObjectMeta
Spec PodDisruptionBudgetSpec: Specification of the desired behavior of the PodDisruptionBudget.

Metadata ObjectMetaArgs
Spec PodDisruptionBudgetSpecArgs: Specification of the desired behavior of the PodDisruptionBudget.

metadata ObjectMeta
spec PodDisruptionBudgetSpec: Specification of the desired behavior of the PodDisruptionBudget.

metadata meta.v1.ObjectMeta
spec PodDisruptionBudgetSpec: Specification of the desired behavior of the PodDisruptionBudget.

metadata meta.v1.ObjectMetaArgs
spec PodDisruptionBudgetSpecArgs: Specification of the desired behavior of the PodDisruptionBudget.

metadata Property Map
spec Property Map: Specification of the desired behavior of the PodDisruptionBudget.

Outputs

All input properties are implicitly available as output properties. Additionally, the PodDisruptionBudget resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Status PodDisruptionBudgetStatus: Most recently observed status of the PodDisruptionBudget.

Id string: The provider-assigned unique ID for this managed resource.
Status PodDisruptionBudgetStatus: Most recently observed status of the PodDisruptionBudget.

id String: The provider-assigned unique ID for this managed resource.
status PodDisruptionBudgetStatus: Most recently observed status of the PodDisruptionBudget.

id string: The provider-assigned unique ID for this managed resource.
status PodDisruptionBudgetStatus: Most recently observed status of the PodDisruptionBudget.

id str: The provider-assigned unique ID for this managed resource.
status PodDisruptionBudgetStatus: Most recently observed status of the PodDisruptionBudget.

id String: The provider-assigned unique ID for this managed resource.
status Property Map: Most recently observed status of the PodDisruptionBudget.

Supporting Types

LabelSelector, LabelSelectorArgs

MatchExpressions List<Pulumi.Kubernetes.Meta.V1.Inputs.LabelSelectorRequirement>: matchExpressions is a list of label selector requirements. The requirements are ANDed.
MatchLabels Dictionary<string, string>: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

MatchExpressions LabelSelectorRequirement: matchExpressions is a list of label selector requirements. The requirements are ANDed.
MatchLabels map[string]string: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchExpressions List<LabelSelectorRequirement>: matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels Map<String,String>: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchExpressions meta.v1.LabelSelectorRequirement[]: matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels {[key: string]: string}: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

match_expressions Sequence[meta.v1.LabelSelectorRequirement]: matchExpressions is a list of label selector requirements. The requirements are ANDed.
match_labels Mapping[str, str]: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchExpressions List<Property Map>: matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels Map<String>: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

LabelSelectorRequirement, LabelSelectorRequirementArgs

Key string: key is the label key that the selector applies to.
Operator string: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
Values List<string>: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Key string: key is the label key that the selector applies to.
Operator string: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
Values []string: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key String: key is the label key that the selector applies to.
operator String: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values List<String>: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key string: key is the label key that the selector applies to.
operator string: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values string[]: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key str: key is the label key that the selector applies to.
operator str: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values Sequence[str]: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key String: key is the label key that the selector applies to.
operator String: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values List<String>: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

ManagedFieldsEntry, ManagedFieldsEntryArgs

ApiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 System.Text.Json.JsonElement: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager string: Manager is an identifier of the workflow managing these fields.
Operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

ApiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 interface{}: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager string: Manager is an identifier of the workflow managing these fields.
Operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion String: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType String: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 JsonElement: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager String: Manager is an identifier of the workflow managing these fields.
operation String: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource String: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time String: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 any: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager string: Manager is an identifier of the workflow managing these fields.
operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

api_version str: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type str: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fields_v1 Any: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager str: Manager is an identifier of the workflow managing these fields.
operation str: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource str: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time str: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion String: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType String: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 JSON: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager String: Manager is an identifier of the workflow managing these fields.
operation String: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource String: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time String: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

ObjectMeta, ObjectMetaArgs

Annotations Dictionary<string, string>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ClusterName string

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

CreationTimestamp string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

DeletionGracePeriodSeconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

DeletionTimestamp string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Finalizers List<string>

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

GenerateName string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Labels Dictionary<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

ManagedFields List<Pulumi.Kubernetes.Meta.V1.Inputs.ManagedFieldsEntry>

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

Name string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Namespace string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

OwnerReferences List<Pulumi.Kubernetes.Meta.V1.Inputs.OwnerReference>

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

ResourceVersion string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

SelfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Annotations map[string]string

ClusterName string

CreationTimestamp string

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

DeletionGracePeriodSeconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

DeletionTimestamp string

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Finalizers []string

GenerateName string

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Labels map[string]string

ManagedFields ManagedFieldsEntry

Name string

Namespace string

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

OwnerReferences OwnerReference

ResourceVersion string

SelfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Map<String,String>

clusterName String

creationTimestamp String

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds Integer

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp String

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers List<String>

generateName String

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation Integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Map<String,String>

managedFields List<ManagedFieldsEntry>

name String

namespace String

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences List<OwnerReference>

resourceVersion String

selfLink String

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations {[key: string]: string}

clusterName string

creationTimestamp string

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp string

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers string[]

generateName string

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation number

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels {[key: string]: string}

managedFields meta.v1.ManagedFieldsEntry[]

name string

namespace string

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences meta.v1.OwnerReference[]

resourceVersion string

selfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Mapping[str, str]

cluster_name str

creation_timestamp str

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletion_grace_period_seconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletion_timestamp str

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers Sequence[str]

generate_name str

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Mapping[str, str]

managed_fields Sequence[meta.v1.ManagedFieldsEntry]

name str

namespace str

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

owner_references Sequence[meta.v1.OwnerReference]

resource_version str

self_link str

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid str

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Map<String>

clusterName String

creationTimestamp String

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds Number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp String

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers List<String>

generateName String

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation Number

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Map<String>

managedFields List<Property Map>

name String

namespace String

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences List<Property Map>

resourceVersion String

selfLink String

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

OwnerReference, OwnerReferenceArgs

ApiVersion string: API version of the referent.
Kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
BlockOwnerDeletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
Controller bool: If true, this reference points to the managing controller.

ApiVersion string: API version of the referent.
Kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
BlockOwnerDeletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
Controller bool: If true, this reference points to the managing controller.

apiVersion String: API version of the referent.
kind String: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name String: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid String: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletion Boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller Boolean: If true, this reference points to the managing controller.

apiVersion string: API version of the referent.
kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletion boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller boolean: If true, this reference points to the managing controller.

api_version str: API version of the referent.
kind str: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name str: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid str: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
block_owner_deletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller bool: If true, this reference points to the managing controller.

apiVersion String: API version of the referent.
kind String: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name String: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid String: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletion Boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller Boolean: If true, this reference points to the managing controller.

PodDisruptionBudgetSpec, PodDisruptionBudgetSpecArgs

MaxUnavailable int | string: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
MinAvailable int | string: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Selector Pulumi.Kubernetes.Meta.V1.Inputs.LabelSelector: Label query over pods whose evictions are managed by the disruption budget.

MaxUnavailable int | string: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
MinAvailable int | string: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Selector LabelSelector: Label query over pods whose evictions are managed by the disruption budget.

maxUnavailable Integer | String: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailable Integer | String: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector LabelSelector: Label query over pods whose evictions are managed by the disruption budget.

maxUnavailable number | string: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailable number | string: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector meta.v1.LabelSelector: Label query over pods whose evictions are managed by the disruption budget.

max_unavailable int | str: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
min_available int | str: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector meta.v1.LabelSelector: Label query over pods whose evictions are managed by the disruption budget.

maxUnavailable Number | String: An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailable Number | String: An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector Property Map: Label query over pods whose evictions are managed by the disruption budget.

PodDisruptionBudgetStatus, PodDisruptionBudgetStatusArgs

CurrentHealthy int: current number of healthy pods
DesiredHealthy int: minimum desired number of healthy pods
DisruptionsAllowed int: Number of pod disruptions that are currently allowed.
ExpectedPods int: total number of pods counted by this disruption budget
DisruptedPods Dictionary<string, string>: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
ObservedGeneration int: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

CurrentHealthy int: current number of healthy pods
DesiredHealthy int: minimum desired number of healthy pods
DisruptionsAllowed int: Number of pod disruptions that are currently allowed.
ExpectedPods int: total number of pods counted by this disruption budget
DisruptedPods map[string]string: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
ObservedGeneration int: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

currentHealthy Integer: current number of healthy pods
desiredHealthy Integer: minimum desired number of healthy pods
disruptionsAllowed Integer: Number of pod disruptions that are currently allowed.
expectedPods Integer: total number of pods counted by this disruption budget
disruptedPods Map<String,String>: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
observedGeneration Integer: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

currentHealthy number: current number of healthy pods
desiredHealthy number: minimum desired number of healthy pods
disruptionsAllowed number: Number of pod disruptions that are currently allowed.
expectedPods number: total number of pods counted by this disruption budget
disruptedPods {[key: string]: string}: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
observedGeneration number: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

current_healthy int: current number of healthy pods
desired_healthy int: minimum desired number of healthy pods
disruptions_allowed int: Number of pod disruptions that are currently allowed.
expected_pods int: total number of pods counted by this disruption budget
disrupted_pods Mapping[str, str]: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
observed_generation int: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

currentHealthy Number: current number of healthy pods
desiredHealthy Number: minimum desired number of healthy pods
disruptionsAllowed Number: Number of pod disruptions that are currently allowed.
expectedPods Number: total number of pods counted by this disruption budget
disruptedPods Map<String>: DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
observedGeneration Number: Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

Package Details

Repository: Kubernetes pulumi/pulumi-kubernetes
License: Apache-2.0

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

pulumi/pulumi-kubernetes

kubernetes.policy/v1beta1.PodDisruptionBudget

On this page

On this page

Create PodDisruptionBudget Resource

Constructor syntax

Parameters

PodDisruptionBudget Resource Properties

Inputs

Outputs

Supporting Types

LabelSelector, LabelSelectorArgs

LabelSelectorRequirement, LabelSelectorRequirementArgs

ManagedFieldsEntry, ManagedFieldsEntryArgs

ObjectMeta, ObjectMetaArgs

OwnerReference, OwnerReferenceArgs

PodDisruptionBudgetSpec, PodDisruptionBudgetSpecArgs

PodDisruptionBudgetStatus, PodDisruptionBudgetStatusArgs

Package Details

On this page

On this page