com.pulumi.kubernetes.apps.v1.inputs.StatefulSetSpecArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.apps.v1.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.kubernetes.apps.v1.inputs.StatefulSetOrdinalsArgs;
import com.pulumi.kubernetes.apps.v1.inputs.StatefulSetPersistentVolumeClaimRetentionPolicyArgs;
import com.pulumi.kubernetes.apps.v1.inputs.StatefulSetUpdateStrategyArgs;
import com.pulumi.kubernetes.core.v1.inputs.PersistentVolumeClaimArgs;
import com.pulumi.kubernetes.core.v1.inputs.PodTemplateSpecArgs;
import com.pulumi.kubernetes.meta.v1.inputs.LabelSelectorArgs;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* A StatefulSetSpec is the specification of a StatefulSet.
*
*/
public final class StatefulSetSpecArgs extends com.pulumi.resources.ResourceArgs {
public static final StatefulSetSpecArgs Empty = new StatefulSetSpecArgs();
/**
* Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
*
*/
@Import(name="minReadySeconds")
private @Nullable Output minReadySeconds;
/**
* @return Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
*
*/
public Optional> minReadySeconds() {
return Optional.ofNullable(this.minReadySeconds);
}
/**
* ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.
*
*/
@Import(name="ordinals")
private @Nullable Output ordinals;
/**
* @return ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.
*
*/
public Optional> ordinals() {
return Optional.ofNullable(this.ordinals);
}
/**
* persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.
*
*/
@Import(name="persistentVolumeClaimRetentionPolicy")
private @Nullable Output persistentVolumeClaimRetentionPolicy;
/**
* @return persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.
*
*/
public Optional> persistentVolumeClaimRetentionPolicy() {
return Optional.ofNullable(this.persistentVolumeClaimRetentionPolicy);
}
/**
* podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
*
*/
@Import(name="podManagementPolicy")
private @Nullable Output podManagementPolicy;
/**
* @return podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
*
*/
public Optional> podManagementPolicy() {
return Optional.ofNullable(this.podManagementPolicy);
}
/**
* replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
*
*/
@Import(name="replicas")
private @Nullable Output replicas;
/**
* @return replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
*
*/
public Optional> replicas() {
return Optional.ofNullable(this.replicas);
}
/**
* revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
*
*/
@Import(name="revisionHistoryLimit")
private @Nullable Output revisionHistoryLimit;
/**
* @return revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
*
*/
public Optional> revisionHistoryLimit() {
return Optional.ofNullable(this.revisionHistoryLimit);
}
/**
* selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
*
*/
@Import(name="selector", required=true)
private Output selector;
/**
* @return selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
*
*/
public Output selector() {
return this.selector;
}
/**
* serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
*
*/
@Import(name="serviceName", required=true)
private Output serviceName;
/**
* @return serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
*
*/
public Output serviceName() {
return this.serviceName;
}
/**
* template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
*
*/
@Import(name="template", required=true)
private Output template;
/**
* @return template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
*
*/
public Output template() {
return this.template;
}
/**
* updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
*
*/
@Import(name="updateStrategy")
private @Nullable Output updateStrategy;
/**
* @return updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
*
*/
public Optional> updateStrategy() {
return Optional.ofNullable(this.updateStrategy);
}
/**
* volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
*
*/
@Import(name="volumeClaimTemplates")
private @Nullable Output> volumeClaimTemplates;
/**
* @return volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
*
*/
public Optional>> volumeClaimTemplates() {
return Optional.ofNullable(this.volumeClaimTemplates);
}
private StatefulSetSpecArgs() {}
private StatefulSetSpecArgs(StatefulSetSpecArgs $) {
this.minReadySeconds = $.minReadySeconds;
this.ordinals = $.ordinals;
this.persistentVolumeClaimRetentionPolicy = $.persistentVolumeClaimRetentionPolicy;
this.podManagementPolicy = $.podManagementPolicy;
this.replicas = $.replicas;
this.revisionHistoryLimit = $.revisionHistoryLimit;
this.selector = $.selector;
this.serviceName = $.serviceName;
this.template = $.template;
this.updateStrategy = $.updateStrategy;
this.volumeClaimTemplates = $.volumeClaimTemplates;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(StatefulSetSpecArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private StatefulSetSpecArgs $;
public Builder() {
$ = new StatefulSetSpecArgs();
}
public Builder(StatefulSetSpecArgs defaults) {
$ = new StatefulSetSpecArgs(Objects.requireNonNull(defaults));
}
/**
* @param minReadySeconds Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
*
* @return builder
*
*/
public Builder minReadySeconds(@Nullable Output minReadySeconds) {
$.minReadySeconds = minReadySeconds;
return this;
}
/**
* @param minReadySeconds Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
*
* @return builder
*
*/
public Builder minReadySeconds(Integer minReadySeconds) {
return minReadySeconds(Output.of(minReadySeconds));
}
/**
* @param ordinals ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.
*
* @return builder
*
*/
public Builder ordinals(@Nullable Output ordinals) {
$.ordinals = ordinals;
return this;
}
/**
* @param ordinals ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.
*
* @return builder
*
*/
public Builder ordinals(StatefulSetOrdinalsArgs ordinals) {
return ordinals(Output.of(ordinals));
}
/**
* @param persistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.
*
* @return builder
*
*/
public Builder persistentVolumeClaimRetentionPolicy(@Nullable Output persistentVolumeClaimRetentionPolicy) {
$.persistentVolumeClaimRetentionPolicy = persistentVolumeClaimRetentionPolicy;
return this;
}
/**
* @param persistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.
*
* @return builder
*
*/
public Builder persistentVolumeClaimRetentionPolicy(StatefulSetPersistentVolumeClaimRetentionPolicyArgs persistentVolumeClaimRetentionPolicy) {
return persistentVolumeClaimRetentionPolicy(Output.of(persistentVolumeClaimRetentionPolicy));
}
/**
* @param podManagementPolicy podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
*
* @return builder
*
*/
public Builder podManagementPolicy(@Nullable Output podManagementPolicy) {
$.podManagementPolicy = podManagementPolicy;
return this;
}
/**
* @param podManagementPolicy podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
*
* @return builder
*
*/
public Builder podManagementPolicy(String podManagementPolicy) {
return podManagementPolicy(Output.of(podManagementPolicy));
}
/**
* @param replicas replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
*
* @return builder
*
*/
public Builder replicas(@Nullable Output replicas) {
$.replicas = replicas;
return this;
}
/**
* @param replicas replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
*
* @return builder
*
*/
public Builder replicas(Integer replicas) {
return replicas(Output.of(replicas));
}
/**
* @param revisionHistoryLimit revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
*
* @return builder
*
*/
public Builder revisionHistoryLimit(@Nullable Output revisionHistoryLimit) {
$.revisionHistoryLimit = revisionHistoryLimit;
return this;
}
/**
* @param revisionHistoryLimit revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
*
* @return builder
*
*/
public Builder revisionHistoryLimit(Integer revisionHistoryLimit) {
return revisionHistoryLimit(Output.of(revisionHistoryLimit));
}
/**
* @param selector selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
*
* @return builder
*
*/
public Builder selector(Output selector) {
$.selector = selector;
return this;
}
/**
* @param selector selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
*
* @return builder
*
*/
public Builder selector(LabelSelectorArgs selector) {
return selector(Output.of(selector));
}
/**
* @param serviceName serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
*
* @return builder
*
*/
public Builder serviceName(Output serviceName) {
$.serviceName = serviceName;
return this;
}
/**
* @param serviceName serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
*
* @return builder
*
*/
public Builder serviceName(String serviceName) {
return serviceName(Output.of(serviceName));
}
/**
* @param template template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
*
* @return builder
*
*/
public Builder template(Output template) {
$.template = template;
return this;
}
/**
* @param template template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
*
* @return builder
*
*/
public Builder template(PodTemplateSpecArgs template) {
return template(Output.of(template));
}
/**
* @param updateStrategy updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
*
* @return builder
*
*/
public Builder updateStrategy(@Nullable Output updateStrategy) {
$.updateStrategy = updateStrategy;
return this;
}
/**
* @param updateStrategy updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
*
* @return builder
*
*/
public Builder updateStrategy(StatefulSetUpdateStrategyArgs updateStrategy) {
return updateStrategy(Output.of(updateStrategy));
}
/**
* @param volumeClaimTemplates volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
*
* @return builder
*
*/
public Builder volumeClaimTemplates(@Nullable Output> volumeClaimTemplates) {
$.volumeClaimTemplates = volumeClaimTemplates;
return this;
}
/**
* @param volumeClaimTemplates volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
*
* @return builder
*
*/
public Builder volumeClaimTemplates(List volumeClaimTemplates) {
return volumeClaimTemplates(Output.of(volumeClaimTemplates));
}
/**
* @param volumeClaimTemplates volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
*
* @return builder
*
*/
public Builder volumeClaimTemplates(PersistentVolumeClaimArgs... volumeClaimTemplates) {
return volumeClaimTemplates(List.of(volumeClaimTemplates));
}
public StatefulSetSpecArgs build() {
if ($.selector == null) {
throw new MissingRequiredPropertyException("StatefulSetSpecArgs", "selector");
}
if ($.serviceName == null) {
throw new MissingRequiredPropertyException("StatefulSetSpecArgs", "serviceName");
}
if ($.template == null) {
throw new MissingRequiredPropertyException("StatefulSetSpecArgs", "template");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy