cdk8s-plus-36 (Java) ¶
Constructs ¶
AbstractPod ¶
- Implements: IPodSelector, INetworkPolicyPeer, ISubject
Initializers ¶
import org.cdk8s.plus36.AbstractPod;
AbstractPod.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .automountServiceAccountToken(java.lang.Boolean)
// .containers(java.util.List<ContainerProps>)
// .dns(PodDnsProps)
// .dockerRegistryAuth(ISecret)
// .enableServiceLinks(java.lang.Boolean)
// .hostAliases(java.util.List<HostAlias>)
// .hostNetwork(java.lang.Boolean)
// .initContainers(java.util.List<ContainerProps>)
// .isolate(java.lang.Boolean)
// .restartPolicy(RestartPolicy)
// .securityContext(PodSecurityContextProps)
// .serviceAccount(IServiceAccount)
// .shareProcessNamespace(java.lang.Boolean)
// .terminationGracePeriod(Duration)
// .volumes(java.util.List<Volume>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
automountServiceAccountToken |
java.lang.Boolean |
Indicates whether a service account token should be automatically mounted. |
containers |
java.util.List<ContainerProps> |
List of containers belonging to the pod. |
dns |
PodDnsProps |
DNS settings for the pod. |
dockerRegistryAuth |
ISecret |
A secret containing docker credentials for authenticating to a registry. |
enableServiceLinks |
java.lang.Boolean |
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. |
hostAliases |
java.util.List<HostAlias> |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
hostNetwork |
java.lang.Boolean |
Host network for the pod. |
initContainers |
java.util.List<ContainerProps> |
List of initialization containers belonging to the pod. |
isolate |
java.lang.Boolean |
Isolates the pod. |
restartPolicy |
RestartPolicy |
Restart policy for all containers within the pod. |
securityContext |
PodSecurityContextProps |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccount |
IServiceAccount |
A service account provides an identity for processes that run in a Pod. |
shareProcessNamespace |
java.lang.Boolean |
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. |
terminationGracePeriod |
org.cdk8s.Duration |
Grace period until the pod is terminated. |
volumes |
java.util.List<Volume> |
List of volumes that can be mounted by containers belonging to the pod. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
- Default: false
Indicates whether a service account token should be automatically mounted.
containersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No containers. Note that a pod spec must include at least one container.
List of containers belonging to the pod.
Containers cannot currently be added or removed. There must be at least one container in a Pod.
You can add additionnal containers using podSpec.addContainer()
dnsOptional ¶
- Type: PodDnsProps
- Default: policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false
DNS settings for the pod.
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
dockerRegistryAuthOptional ¶
- Type: ISecret
- Default: No auth. Images are assumed to be publicly available.
A secret containing docker credentials for authenticating to a registry.
enableServiceLinksOptional ¶
- Type: java.lang.Boolean
- Default: true
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links.
hostAliasesOptional ¶
- Type: java.util.List<HostAlias>
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
hostNetworkOptional ¶
- Type: java.lang.Boolean
- Default: false
Host network for the pod.
initContainersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No init containers.
List of initialization containers belonging to the pod.
Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.
Init containers cannot currently be added ,removed or updated.
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
isolateOptional ¶
- Type: java.lang.Boolean
- Default: false
Isolates the pod.
This will prevent any ingress or egress connections to / from this pod.
You can however allow explicit connections post instantiation by using the .connections property.
restartPolicyOptional ¶
- Type: RestartPolicy
- Default: RestartPolicy.ALWAYS
Restart policy for all containers within the pod.
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
securityContextOptional ¶
- Type: PodSecurityContextProps
- Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true
SecurityContext holds pod-level security attributes and common container settings.
serviceAccountOptional ¶
- Type: IServiceAccount
- Default: No service account.
A service account provides an identity for processes that run in a Pod.
When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespaceOptional ¶
- Type: java.lang.Boolean
- Default: false
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.
https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
terminationGracePeriodOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(30)
Grace period until the pod is terminated.
volumesOptional ¶
- Type: java.util.List<Volume>
- Default: No volumes.
List of volumes that can be mounted by containers belonging to the pod.
You can also add volumes later using podSpec.addVolume()
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addContainer |
No description. |
addHostAlias |
No description. |
addInitContainer |
No description. |
addVolume |
No description. |
attachContainer |
No description. |
toNetworkPolicyPeerConfig |
Return the configuration of this peer. |
toPodSelector |
Convert the peer into a pod selector, if possible. |
toPodSelectorConfig |
Return the configuration of this selector. |
toSubjectConfiguration |
Return the subject configuration. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addContainer ¶
public Container addContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addHostAlias ¶
public void addHostAlias(HostAlias hostAlias)
hostAliasRequired ¶
- Type: HostAlias
addInitContainer ¶
public Container addInitContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addVolume ¶
public void addVolume(Volume vol)
volRequired ¶
- Type: Volume
attachContainer ¶
public void attachContainer(Container cont)
contRequired ¶
- Type: Container
toNetworkPolicyPeerConfig ¶
public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig()
Return the configuration of this peer.
toPodSelector ¶
public IPodSelector toPodSelector()
Convert the peer into a pod selector, if possible.
toPodSelectorConfig ¶
public PodSelectorConfig toPodSelectorConfig()
Return the configuration of this selector.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.AbstractPod;
AbstractPod.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
automountServiceAccountToken |
java.lang.Boolean |
No description. |
containers |
java.util.List<Container> |
No description. |
dns |
PodDns |
No description. |
hostAliases |
java.util.List<HostAlias> |
No description. |
initContainers |
java.util.List<Container> |
No description. |
podMetadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
securityContext |
PodSecurityContext |
No description. |
shareProcessNamespace |
java.lang.Boolean |
No description. |
volumes |
java.util.List<Volume> |
No description. |
dockerRegistryAuth |
ISecret |
No description. |
enableServiceLinks |
java.lang.Boolean |
No description. |
hostNetwork |
java.lang.Boolean |
No description. |
restartPolicy |
RestartPolicy |
No description. |
serviceAccount |
IServiceAccount |
No description. |
terminationGracePeriod |
org.cdk8s.Duration |
No description. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
automountServiceAccountTokenRequired ¶
public java.lang.Boolean getAutomountServiceAccountToken();
- Type: java.lang.Boolean
containersRequired ¶
public java.util.List<Container> getContainers();
- Type: java.util.List<Container>
dnsRequired ¶
public PodDns getDns();
- Type: PodDns
hostAliasesRequired ¶
public java.util.List<HostAlias> getHostAliases();
- Type: java.util.List<HostAlias>
initContainersRequired ¶
public java.util.List<Container> getInitContainers();
- Type: java.util.List<Container>
podMetadataRequired ¶
public ApiObjectMetadataDefinition getPodMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
securityContextRequired ¶
public PodSecurityContext getSecurityContext();
- Type: PodSecurityContext
shareProcessNamespaceRequired ¶
public java.lang.Boolean getShareProcessNamespace();
- Type: java.lang.Boolean
volumesRequired ¶
public java.util.List<Volume> getVolumes();
- Type: java.util.List<Volume>
dockerRegistryAuthOptional ¶
public ISecret getDockerRegistryAuth();
- Type: ISecret
enableServiceLinksOptional ¶
public java.lang.Boolean getEnableServiceLinks();
- Type: java.lang.Boolean
hostNetworkOptional ¶
public java.lang.Boolean getHostNetwork();
- Type: java.lang.Boolean
restartPolicyOptional ¶
public RestartPolicy getRestartPolicy();
- Type: RestartPolicy
serviceAccountOptional ¶
public IServiceAccount getServiceAccount();
- Type: IServiceAccount
terminationGracePeriodOptional ¶
public Duration getTerminationGracePeriod();
- Type: org.cdk8s.Duration
AwsElasticBlockStorePersistentVolume ¶
Represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod.
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Initializers ¶
import org.cdk8s.plus36.AwsElasticBlockStorePersistentVolume;
AwsElasticBlockStorePersistentVolume.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .accessModes(java.util.List<PersistentVolumeAccessMode>)
// .claim(IPersistentVolumeClaim)
// .mountOptions(java.util.List<java.lang.String>)
// .reclaimPolicy(PersistentVolumeReclaimPolicy)
// .storage(Size)
// .storageClassName(java.lang.String)
// .volumeMode(PersistentVolumeMode)
.volumeId(java.lang.String)
// .fsType(java.lang.String)
// .partition(java.lang.Number)
// .readOnly(java.lang.Boolean)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Contains all ways the volume can be mounted. |
claim |
IPersistentVolumeClaim |
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. |
mountOptions |
java.util.List |
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. |
storage |
org.cdk8s.Size |
What is the storage capacity of this volume. |
storageClassName |
java.lang.String |
Name of StorageClass to which this persistent volume belongs. |
volumeMode |
PersistentVolumeMode |
Defines what type of volume is required by the claim. |
volumeId |
java.lang.String |
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). |
fsType |
java.lang.String |
Filesystem type of the volume that you want to mount. |
partition |
java.lang.Number |
The partition in the volume that you want to mount. |
readOnly |
java.lang.Boolean |
Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
accessModesOptional ¶
- Type: java.util.List<PersistentVolumeAccessMode>
- Default: No access modes.
Contains all ways the volume can be mounted.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
claimOptional ¶
- Type: IPersistentVolumeClaim
- Default: Not bound to a specific claim.
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
Expected to be non-nil when bound.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
mountOptionsOptional ¶
- Type: java.util.List
- Default: No options.
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
reclaimPolicyOptional ¶
- Type: PersistentVolumeReclaimPolicy
- Default: PersistentVolumeReclaimPolicy.RETAIN
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.
The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
storageOptional ¶
- Type: org.cdk8s.Size
- Default: No specified.
What is the storage capacity of this volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
storageClassNameOptional ¶
- Type: java.lang.String
- Default: Volume does not belong to any storage class.
Name of StorageClass to which this persistent volume belongs.
volumeModeOptional ¶
- Type: PersistentVolumeMode
- Default: VolumeMode.FILE_SYSTEM
Defines what type of volume is required by the claim.
volumeIdRequired ¶
- Type: java.lang.String
Unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
fsTypeOptional ¶
- Type: java.lang.String
- Default: ‘ext4’
Filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partitionOptional ¶
- Type: java.lang.Number
- Default: No partition.
The partition in the volume that you want to mount.
If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty).
readOnlyOptional ¶
- Type: java.lang.Boolean
- Default: false
Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
asVolume |
Convert the piece of storage into a concrete volume. |
bind |
Bind a volume to a specific claim. |
reserve |
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
asVolume ¶
public Volume asVolume()
Convert the piece of storage into a concrete volume.
bind ¶
public void bind(IPersistentVolumeClaim claim)
Bind a volume to a specific claim.
Note that you must also bind the claim to the volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding
claimRequired ¶
- Type: IPersistentVolumeClaim
The PVC to bind to.
reserve ¶
public PersistentVolumeClaim reserve()
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.
Note that this method will throw in case the volume is already claimed.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromPersistentVolumeName |
Imports a pv from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.AwsElasticBlockStorePersistentVolume;
AwsElasticBlockStorePersistentVolume.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromPersistentVolumeName ¶
import org.cdk8s.plus36.AwsElasticBlockStorePersistentVolume;
AwsElasticBlockStorePersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName)
Imports a pv from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
volumeNameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
mode |
PersistentVolumeMode |
Volume mode of this volume. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
Reclaim policy of this volume. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Access modes requirement of this claim. |
claim |
IPersistentVolumeClaim |
PVC this volume is bound to. |
mountOptions |
java.util.List |
Mount options of this volume. |
storage |
org.cdk8s.Size |
Storage size of this volume. |
storageClassName |
java.lang.String |
Storage class this volume belongs to. |
fsType |
java.lang.String |
File system type of this volume. |
readOnly |
java.lang.Boolean |
Whether or not it is mounted as a read-only volume. |
volumeId |
java.lang.String |
Volume id of this volume. |
partition |
java.lang.Number |
Partition of this volume. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
modeRequired ¶
public PersistentVolumeMode getMode();
- Type: PersistentVolumeMode
Volume mode of this volume.
reclaimPolicyRequired ¶
public PersistentVolumeReclaimPolicy getReclaimPolicy();
Reclaim policy of this volume.
accessModesOptional ¶
public java.util.List<PersistentVolumeAccessMode> getAccessModes();
- Type: java.util.List<PersistentVolumeAccessMode>
Access modes requirement of this claim.
claimOptional ¶
public IPersistentVolumeClaim getClaim();
- Type: IPersistentVolumeClaim
PVC this volume is bound to.
Undefined means this volume is not yet claimed by any PVC.
mountOptionsOptional ¶
public java.util.List<java.lang.String> getMountOptions();
- Type: java.util.List
Mount options of this volume.
storageOptional ¶
public Size getStorage();
- Type: org.cdk8s.Size
Storage size of this volume.
storageClassNameOptional ¶
public java.lang.String getStorageClassName();
- Type: java.lang.String
Storage class this volume belongs to.
fsTypeRequired ¶
public java.lang.String getFsType();
- Type: java.lang.String
File system type of this volume.
readOnlyRequired ¶
public java.lang.Boolean getReadOnly();
- Type: java.lang.Boolean
Whether or not it is mounted as a read-only volume.
volumeIdRequired ¶
public java.lang.String getVolumeId();
- Type: java.lang.String
Volume id of this volume.
partitionOptional ¶
public java.lang.Number getPartition();
- Type: java.lang.Number
Partition of this volume.
AzureDiskPersistentVolume ¶
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Initializers ¶
import org.cdk8s.plus36.AzureDiskPersistentVolume;
AzureDiskPersistentVolume.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .accessModes(java.util.List<PersistentVolumeAccessMode>)
// .claim(IPersistentVolumeClaim)
// .mountOptions(java.util.List<java.lang.String>)
// .reclaimPolicy(PersistentVolumeReclaimPolicy)
// .storage(Size)
// .storageClassName(java.lang.String)
// .volumeMode(PersistentVolumeMode)
.diskName(java.lang.String)
.diskUri(java.lang.String)
// .cachingMode(AzureDiskPersistentVolumeCachingMode)
// .fsType(java.lang.String)
// .kind(AzureDiskPersistentVolumeKind)
// .readOnly(java.lang.Boolean)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Contains all ways the volume can be mounted. |
claim |
IPersistentVolumeClaim |
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. |
mountOptions |
java.util.List |
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. |
storage |
org.cdk8s.Size |
What is the storage capacity of this volume. |
storageClassName |
java.lang.String |
Name of StorageClass to which this persistent volume belongs. |
volumeMode |
PersistentVolumeMode |
Defines what type of volume is required by the claim. |
diskName |
java.lang.String |
The Name of the data disk in the blob storage. |
diskUri |
java.lang.String |
The URI the data disk in the blob storage. |
cachingMode |
AzureDiskPersistentVolumeCachingMode |
Host Caching mode. |
fsType |
java.lang.String |
Filesystem type to mount. |
kind |
AzureDiskPersistentVolumeKind |
Kind of disk. |
readOnly |
java.lang.Boolean |
Force the ReadOnly setting in VolumeMounts. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
accessModesOptional ¶
- Type: java.util.List<PersistentVolumeAccessMode>
- Default: No access modes.
Contains all ways the volume can be mounted.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
claimOptional ¶
- Type: IPersistentVolumeClaim
- Default: Not bound to a specific claim.
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
Expected to be non-nil when bound.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
mountOptionsOptional ¶
- Type: java.util.List
- Default: No options.
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
reclaimPolicyOptional ¶
- Type: PersistentVolumeReclaimPolicy
- Default: PersistentVolumeReclaimPolicy.RETAIN
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.
The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
storageOptional ¶
- Type: org.cdk8s.Size
- Default: No specified.
What is the storage capacity of this volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
storageClassNameOptional ¶
- Type: java.lang.String
- Default: Volume does not belong to any storage class.
Name of StorageClass to which this persistent volume belongs.
volumeModeOptional ¶
- Type: PersistentVolumeMode
- Default: VolumeMode.FILE_SYSTEM
Defines what type of volume is required by the claim.
diskNameRequired ¶
- Type: java.lang.String
The Name of the data disk in the blob storage.
diskUriRequired ¶
- Type: java.lang.String
The URI the data disk in the blob storage.
cachingModeOptional ¶
- Type: AzureDiskPersistentVolumeCachingMode
- Default: AzureDiskPersistentVolumeCachingMode.NONE.
Host Caching mode.
fsTypeOptional ¶
- Type: java.lang.String
- Default: ‘ext4’
Filesystem type to mount.
Must be a filesystem type supported by the host operating system.
kindOptional ¶
- Type: AzureDiskPersistentVolumeKind
- Default: AzureDiskPersistentVolumeKind.SHARED
Kind of disk.
readOnlyOptional ¶
- Type: java.lang.Boolean
- Default: false
Force the ReadOnly setting in VolumeMounts.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
asVolume |
Convert the piece of storage into a concrete volume. |
bind |
Bind a volume to a specific claim. |
reserve |
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
asVolume ¶
public Volume asVolume()
Convert the piece of storage into a concrete volume.
bind ¶
public void bind(IPersistentVolumeClaim claim)
Bind a volume to a specific claim.
Note that you must also bind the claim to the volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding
claimRequired ¶
- Type: IPersistentVolumeClaim
The PVC to bind to.
reserve ¶
public PersistentVolumeClaim reserve()
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.
Note that this method will throw in case the volume is already claimed.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromPersistentVolumeName |
Imports a pv from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.AzureDiskPersistentVolume;
AzureDiskPersistentVolume.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromPersistentVolumeName ¶
import org.cdk8s.plus36.AzureDiskPersistentVolume;
AzureDiskPersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName)
Imports a pv from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
volumeNameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
mode |
PersistentVolumeMode |
Volume mode of this volume. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
Reclaim policy of this volume. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Access modes requirement of this claim. |
claim |
IPersistentVolumeClaim |
PVC this volume is bound to. |
mountOptions |
java.util.List |
Mount options of this volume. |
storage |
org.cdk8s.Size |
Storage size of this volume. |
storageClassName |
java.lang.String |
Storage class this volume belongs to. |
azureKind |
AzureDiskPersistentVolumeKind |
Azure kind of this volume. |
cachingMode |
AzureDiskPersistentVolumeCachingMode |
Caching mode of this volume. |
diskName |
java.lang.String |
Disk name of this volume. |
diskUri |
java.lang.String |
Disk URI of this volume. |
fsType |
java.lang.String |
File system type of this volume. |
readOnly |
java.lang.Boolean |
Whether or not it is mounted as a read-only volume. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
modeRequired ¶
public PersistentVolumeMode getMode();
- Type: PersistentVolumeMode
Volume mode of this volume.
reclaimPolicyRequired ¶
public PersistentVolumeReclaimPolicy getReclaimPolicy();
Reclaim policy of this volume.
accessModesOptional ¶
public java.util.List<PersistentVolumeAccessMode> getAccessModes();
- Type: java.util.List<PersistentVolumeAccessMode>
Access modes requirement of this claim.
claimOptional ¶
public IPersistentVolumeClaim getClaim();
- Type: IPersistentVolumeClaim
PVC this volume is bound to.
Undefined means this volume is not yet claimed by any PVC.
mountOptionsOptional ¶
public java.util.List<java.lang.String> getMountOptions();
- Type: java.util.List
Mount options of this volume.
storageOptional ¶
public Size getStorage();
- Type: org.cdk8s.Size
Storage size of this volume.
storageClassNameOptional ¶
public java.lang.String getStorageClassName();
- Type: java.lang.String
Storage class this volume belongs to.
azureKindRequired ¶
public AzureDiskPersistentVolumeKind getAzureKind();
Azure kind of this volume.
cachingModeRequired ¶
public AzureDiskPersistentVolumeCachingMode getCachingMode();
Caching mode of this volume.
diskNameRequired ¶
public java.lang.String getDiskName();
- Type: java.lang.String
Disk name of this volume.
diskUriRequired ¶
public java.lang.String getDiskUri();
- Type: java.lang.String
Disk URI of this volume.
fsTypeRequired ¶
public java.lang.String getFsType();
- Type: java.lang.String
File system type of this volume.
readOnlyRequired ¶
public java.lang.Boolean getReadOnly();
- Type: java.lang.Boolean
Whether or not it is mounted as a read-only volume.
BasicAuthSecret ¶
Create a secret for basic authentication.
https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret
Initializers ¶
import org.cdk8s.plus36.BasicAuthSecret;
BasicAuthSecret.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .immutable(java.lang.Boolean)
.password(java.lang.String)
.username(java.lang.String)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
immutable |
java.lang.Boolean |
If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). |
password |
java.lang.String |
The password or token for authentication. |
username |
java.lang.String |
The user name for authentication. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
immutableOptional ¶
- Type: java.lang.Boolean
- Default: false
If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).
If not set to true, the field can be modified at any time.
passwordRequired ¶
- Type: java.lang.String
The password or token for authentication.
usernameRequired ¶
- Type: java.lang.String
The user name for authentication.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addStringData |
Adds a string data field to the secret. |
envValue |
Returns EnvValue object from a secret’s key. |
getStringData |
Gets a string data by key or undefined. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addStringData ¶
public void addStringData(java.lang.String key, java.lang.String value)
Adds a string data field to the secret.
keyRequired ¶
- Type: java.lang.String
Key.
valueRequired ¶
- Type: java.lang.String
Value.
envValue ¶
public EnvValue envValue(java.lang.String key)
public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options)
Returns EnvValue object from a secret’s key.
keyRequired ¶
- Type: java.lang.String
optionsOptional ¶
getStringData ¶
public java.lang.String getStringData(java.lang.String key)
Gets a string data by key or undefined.
keyRequired ¶
- Type: java.lang.String
Key.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromSecretName |
Imports a secret from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.BasicAuthSecret;
BasicAuthSecret.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromSecretName ¶
import org.cdk8s.plus36.BasicAuthSecret;
BasicAuthSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name)
Imports a secret from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
nameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
immutable |
java.lang.Boolean |
Whether or not the secret is immutable. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
immutableRequired ¶
public java.lang.Boolean getImmutable();
- Type: java.lang.Boolean
Whether or not the secret is immutable.
ClusterRole ¶
- Implements: IClusterRole, IRole
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
Initializers ¶
import org.cdk8s.plus36.ClusterRole;
ClusterRole.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .aggregationLabels(java.util.Map<java.lang.String, java.lang.String>)
// .rules(java.util.List<ClusterRolePolicyRule>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
aggregationLabels |
java.util.Map |
Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole’s rules. |
rules |
java.util.List<ClusterRolePolicyRule> |
A list of rules the role should allow. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
aggregationLabelsOptional ¶
- Type: java.util.Map
Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole’s rules.
rulesOptional ¶
- Type: java.util.List<ClusterRolePolicyRule>
- Default: []
A list of rules the role should allow.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
aggregate |
Aggregate rules from roles matching this label selector. |
allow |
Add permission to perform a list of HTTP verbs on a collection of resources. |
allowCreate |
Add “create” permission for the resources. |
allowDelete |
Add “delete” permission for the resources. |
allowDeleteCollection |
Add “deletecollection” permission for the resources. |
allowGet |
Add “get” permission for the resources. |
allowList |
Add “list” permission for the resources. |
allowPatch |
Add “patch” permission for the resources. |
allowRead |
Add “get”, “list”, and “watch” permissions for the resources. |
allowReadWrite |
Add “get”, “list”, “watch”, “create”, “update”, “patch”, “delete”, and “deletecollection” permissions for the resources. |
allowUpdate |
Add “update” permission for the resources. |
allowWatch |
Add “watch” permission for the resources. |
bind |
Create a ClusterRoleBinding that binds the permissions in this ClusterRole to a list of subjects, without namespace restrictions. |
bindInNamespace |
Create a RoleBinding that binds the permissions in this ClusterRole to a list of subjects, that will only apply to the given namespace. |
combine |
Combines the rules of the argument ClusterRole into this ClusterRole using aggregation labels. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
aggregate ¶
public void aggregate(java.lang.String key, java.lang.String value)
Aggregate rules from roles matching this label selector.
keyRequired ¶
- Type: java.lang.String
valueRequired ¶
- Type: java.lang.String
allow ¶
public void allow(java.util.List<java.lang.String> verbs, IApiEndpoint... endpoints)
Add permission to perform a list of HTTP verbs on a collection of resources.
https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb
verbsRequired ¶
- Type: java.util.List
endpointsRequired ¶
- Type: IApiEndpoint…
The endpoints(s) to apply to.
allowCreate ¶
public void allowCreate(IApiEndpoint... endpoints)
Add “create” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowDelete ¶
public void allowDelete(IApiEndpoint... endpoints)
Add “delete” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowDeleteCollection ¶
public void allowDeleteCollection(IApiEndpoint... endpoints)
Add “deletecollection” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowGet ¶
public void allowGet(IApiEndpoint... endpoints)
Add “get” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowList ¶
public void allowList(IApiEndpoint... endpoints)
Add “list” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowPatch ¶
public void allowPatch(IApiEndpoint... endpoints)
Add “patch” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowRead ¶
public void allowRead(IApiEndpoint... endpoints)
Add “get”, “list”, and “watch” permissions for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowReadWrite ¶
public void allowReadWrite(IApiEndpoint... endpoints)
Add “get”, “list”, “watch”, “create”, “update”, “patch”, “delete”, and “deletecollection” permissions for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowUpdate ¶
public void allowUpdate(IApiEndpoint... endpoints)
Add “update” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
allowWatch ¶
public void allowWatch(IApiEndpoint... endpoints)
Add “watch” permission for the resources.
endpointsRequired ¶
- Type: IApiEndpoint…
The resource(s) to apply to.
bind ¶
public ClusterRoleBinding bind(ISubject... subjects)
Create a ClusterRoleBinding that binds the permissions in this ClusterRole to a list of subjects, without namespace restrictions.
subjectsRequired ¶
- Type: ISubject…
a list of subjects to bind to.
bindInNamespace ¶
public RoleBinding bindInNamespace(java.lang.String namespace, ISubject... subjects)
Create a RoleBinding that binds the permissions in this ClusterRole to a list of subjects, that will only apply to the given namespace.
namespaceRequired ¶
- Type: java.lang.String
the namespace to limit permissions to.
subjectsRequired ¶
- Type: ISubject…
a list of subjects to bind to.
combine ¶
public void combine(ClusterRole rol)
Combines the rules of the argument ClusterRole into this ClusterRole using aggregation labels.
rolRequired ¶
- Type: ClusterRole
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromClusterRoleName |
Imports a role from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.ClusterRole;
ClusterRole.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromClusterRoleName ¶
import org.cdk8s.plus36.ClusterRole;
ClusterRole.fromClusterRoleName(Construct scope, java.lang.String id, java.lang.String name)
Imports a role from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
nameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
rules |
java.util.List<ClusterRolePolicyRule> |
Rules associaated with this Role. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
rulesRequired ¶
public java.util.List<ClusterRolePolicyRule> getRules();
- Type: java.util.List<ClusterRolePolicyRule>
Rules associaated with this Role.
Returns a copy, use allow to add rules.
ClusterRoleBinding ¶
A ClusterRoleBinding grants permissions cluster-wide to a user or set of users.
Initializers ¶
import org.cdk8s.plus36.ClusterRoleBinding;
ClusterRoleBinding.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
.role(IClusterRole)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
role |
IClusterRole |
The role to bind to. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
roleRequired ¶
- Type: IClusterRole
The role to bind to.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addSubjects |
Adds a subject to the role. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addSubjects ¶
public void addSubjects(ISubject... subjects)
Adds a subject to the role.
subjectsRequired ¶
- Type: ISubject…
The subjects to add.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.ClusterRoleBinding;
ClusterRoleBinding.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
role |
IClusterRole |
No description. |
subjects |
java.util.List<ISubject> |
No description. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
roleRequired ¶
public IClusterRole getRole();
- Type: IClusterRole
subjectsRequired ¶
public java.util.List<ISubject> getSubjects();
- Type: java.util.List<ISubject>
ConfigMap ¶
- Implements: IConfigMap
ConfigMap holds configuration data for pods to consume.
Initializers ¶
import org.cdk8s.plus36.ConfigMap;
ConfigMap.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .binaryData(java.util.Map<java.lang.String, java.lang.String>)
// .data(java.util.Map<java.lang.String, java.lang.String>)
// .immutable(java.lang.Boolean)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
binaryData |
java.util.Map |
BinaryData contains the binary data. |
data |
java.util.Map |
Data contains the configuration data. |
immutable |
java.lang.Boolean |
If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
binaryDataOptional ¶
- Type: java.util.Map
BinaryData contains the binary data.
Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process.
You can also add binary data using configMap.addBinaryData().
dataOptional ¶
- Type: java.util.Map
Data contains the configuration data.
Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
You can also add data using configMap.addData().
immutableOptional ¶
- Type: java.lang.Boolean
- Default: false
If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified).
If not set to true, the field can be modified at any time.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addBinaryData |
Adds a binary data entry to the config map. |
addData |
Adds a data entry to the config map. |
addDirectory |
Adds a directory to the ConfigMap. |
addFile |
Adds a file to the ConfigMap. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addBinaryData ¶
public void addBinaryData(java.lang.String key, java.lang.String value)
Adds a binary data entry to the config map.
BinaryData can contain byte sequences that are not in the UTF-8 range.
keyRequired ¶
- Type: java.lang.String
The key.
valueRequired ¶
- Type: java.lang.String
The value.
addData ¶
public void addData(java.lang.String key, java.lang.String value)
Adds a data entry to the config map.
keyRequired ¶
- Type: java.lang.String
The key.
valueRequired ¶
- Type: java.lang.String
The value.
addDirectory ¶
public void addDirectory(java.lang.String localDir)
public void addDirectory(java.lang.String localDir, AddDirectoryOptions options)
Adds a directory to the ConfigMap.
localDirRequired ¶
- Type: java.lang.String
A path to a local directory.
optionsOptional ¶
- Type: AddDirectoryOptions
Options.
addFile ¶
public void addFile(java.lang.String localFile)
public void addFile(java.lang.String localFile, java.lang.String key)
Adds a file to the ConfigMap.
localFileRequired ¶
- Type: java.lang.String
The path to the local file.
keyOptional ¶
- Type: java.lang.String
The ConfigMap key (default to the file name).
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromConfigMapName |
Represents a ConfigMap created elsewhere. |
isConstruct ¶
import org.cdk8s.plus36.ConfigMap;
ConfigMap.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromConfigMapName ¶
import org.cdk8s.plus36.ConfigMap;
ConfigMap.fromConfigMapName(Construct scope, java.lang.String id, java.lang.String name)
Represents a ConfigMap created elsewhere.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
nameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
binaryData |
java.util.Map |
The binary data associated with this config map. |
data |
java.util.Map |
The data associated with this config map. |
immutable |
java.lang.Boolean |
Whether or not this config map is immutable. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
binaryDataRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getBinaryData();
- Type: java.util.Map
The binary data associated with this config map.
Returns a copy. To add data records, use addBinaryData() or addData().
dataRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getData();
- Type: java.util.Map
The data associated with this config map.
Returns an copy. To add data records, use addData() or addBinaryData().
immutableRequired ¶
public java.lang.Boolean getImmutable();
- Type: java.lang.Boolean
Whether or not this config map is immutable.
CronJob ¶
A CronJob is responsible for creating a Job and scheduling it based on provided cron schedule.
This helps running Jobs in a recurring manner.
Initializers ¶
import org.cdk8s.plus36.CronJob;
CronJob.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .automountServiceAccountToken(java.lang.Boolean)
// .containers(java.util.List<ContainerProps>)
// .dns(PodDnsProps)
// .dockerRegistryAuth(ISecret)
// .enableServiceLinks(java.lang.Boolean)
// .hostAliases(java.util.List<HostAlias>)
// .hostNetwork(java.lang.Boolean)
// .initContainers(java.util.List<ContainerProps>)
// .isolate(java.lang.Boolean)
// .restartPolicy(RestartPolicy)
// .securityContext(PodSecurityContextProps)
// .serviceAccount(IServiceAccount)
// .shareProcessNamespace(java.lang.Boolean)
// .terminationGracePeriod(Duration)
// .volumes(java.util.List<Volume>)
// .podMetadata(ApiObjectMetadata)
// .select(java.lang.Boolean)
// .spread(java.lang.Boolean)
// .activeDeadline(Duration)
// .backoffLimit(java.lang.Number)
// .ttlAfterFinished(Duration)
.schedule(Cron)
// .concurrencyPolicy(ConcurrencyPolicy)
// .failedJobsRetained(java.lang.Number)
// .startingDeadline(Duration)
// .successfulJobsRetained(java.lang.Number)
// .suspend(java.lang.Boolean)
// .timeZone(java.lang.String)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
automountServiceAccountToken |
java.lang.Boolean |
Indicates whether a service account token should be automatically mounted. |
containers |
java.util.List<ContainerProps> |
List of containers belonging to the pod. |
dns |
PodDnsProps |
DNS settings for the pod. |
dockerRegistryAuth |
ISecret |
A secret containing docker credentials for authenticating to a registry. |
enableServiceLinks |
java.lang.Boolean |
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. |
hostAliases |
java.util.List<HostAlias> |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
hostNetwork |
java.lang.Boolean |
Host network for the pod. |
initContainers |
java.util.List<ContainerProps> |
List of initialization containers belonging to the pod. |
isolate |
java.lang.Boolean |
Isolates the pod. |
restartPolicy |
RestartPolicy |
Restart policy for all containers within the pod. |
securityContext |
PodSecurityContextProps |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccount |
IServiceAccount |
A service account provides an identity for processes that run in a Pod. |
shareProcessNamespace |
java.lang.Boolean |
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. |
terminationGracePeriod |
org.cdk8s.Duration |
Grace period until the pod is terminated. |
volumes |
java.util.List<Volume> |
List of volumes that can be mounted by containers belonging to the pod. |
podMetadata |
org.cdk8s.ApiObjectMetadata |
The pod metadata of this workload. |
select |
java.lang.Boolean |
Automatically allocates a pod label selector for this workload and add it to the pod metadata. |
spread |
java.lang.Boolean |
Automatically spread pods across hostname and zones. |
activeDeadline |
org.cdk8s.Duration |
Specifies the duration the job may be active before the system tries to terminate it. |
backoffLimit |
java.lang.Number |
Specifies the number of retries before marking this job failed. |
ttlAfterFinished |
org.cdk8s.Duration |
Limits the lifetime of a Job that has finished execution (either Complete or Failed). |
schedule |
org.cdk8s.Cron |
Specifies the time in which the job would run again. |
concurrencyPolicy |
ConcurrencyPolicy |
Specifies the concurrency policy for the job. |
failedJobsRetained |
java.lang.Number |
Specifies the number of failed jobs history retained. |
startingDeadline |
org.cdk8s.Duration |
Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed. |
successfulJobsRetained |
java.lang.Number |
Specifies the number of successful jobs history retained. |
suspend |
java.lang.Boolean |
Specifies if the cron job should be suspended. |
timeZone |
java.lang.String |
Specifies the timezone for the job. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
- Default: false
Indicates whether a service account token should be automatically mounted.
containersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No containers. Note that a pod spec must include at least one container.
List of containers belonging to the pod.
Containers cannot currently be added or removed. There must be at least one container in a Pod.
You can add additionnal containers using podSpec.addContainer()
dnsOptional ¶
- Type: PodDnsProps
- Default: policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false
DNS settings for the pod.
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
dockerRegistryAuthOptional ¶
- Type: ISecret
- Default: No auth. Images are assumed to be publicly available.
A secret containing docker credentials for authenticating to a registry.
enableServiceLinksOptional ¶
- Type: java.lang.Boolean
- Default: true
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links.
hostAliasesOptional ¶
- Type: java.util.List<HostAlias>
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
hostNetworkOptional ¶
- Type: java.lang.Boolean
- Default: false
Host network for the pod.
initContainersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No init containers.
List of initialization containers belonging to the pod.
Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.
Init containers cannot currently be added ,removed or updated.
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
isolateOptional ¶
- Type: java.lang.Boolean
- Default: false
Isolates the pod.
This will prevent any ingress or egress connections to / from this pod.
You can however allow explicit connections post instantiation by using the .connections property.
restartPolicyOptional ¶
- Type: RestartPolicy
- Default: RestartPolicy.ALWAYS
Restart policy for all containers within the pod.
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
securityContextOptional ¶
- Type: PodSecurityContextProps
- Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true
SecurityContext holds pod-level security attributes and common container settings.
serviceAccountOptional ¶
- Type: IServiceAccount
- Default: No service account.
A service account provides an identity for processes that run in a Pod.
When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespaceOptional ¶
- Type: java.lang.Boolean
- Default: false
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.
https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
terminationGracePeriodOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(30)
Grace period until the pod is terminated.
volumesOptional ¶
- Type: java.util.List<Volume>
- Default: No volumes.
List of volumes that can be mounted by containers belonging to the pod.
You can also add volumes later using podSpec.addVolume()
podMetadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
The pod metadata of this workload.
selectOptional ¶
- Type: java.lang.Boolean
- Default: true
Automatically allocates a pod label selector for this workload and add it to the pod metadata.
This ensures this workload manages pods created by its pod template.
spreadOptional ¶
- Type: java.lang.Boolean
- Default: false
Automatically spread pods across hostname and zones.
activeDeadlineOptional ¶
- Type: org.cdk8s.Duration
- Default: If unset, then there is no deadline.
Specifies the duration the job may be active before the system tries to terminate it.
backoffLimitOptional ¶
- Type: java.lang.Number
- Default: If not set, system defaults to 6.
Specifies the number of retries before marking this job failed.
ttlAfterFinishedOptional ¶
- Type: org.cdk8s.Duration
- Default: If this field is unset, the Job won’t be automatically deleted.
Limits the lifetime of a Job that has finished execution (either Complete or Failed).
If this field is set, after the Job finishes, it is eligible to
be automatically deleted. When the Job is being deleted, its lifecycle
guarantees (e.g. finalizers) will be honored. If this field is set to zero,
the Job becomes eligible to be deleted immediately after it finishes. This
field is alpha-level and is only honored by servers that enable the
TTLAfterFinished feature.
scheduleRequired ¶
- Type: org.cdk8s.Cron
Specifies the time in which the job would run again.
This is defined as a cron expression in the CronJob resource.
concurrencyPolicyOptional ¶
- Type: ConcurrencyPolicy
- Default: ConcurrencyPolicy.Forbid
Specifies the concurrency policy for the job.
failedJobsRetainedOptional ¶
- Type: java.lang.Number
- Default: 1
Specifies the number of failed jobs history retained.
This would retain the Job and the associated Pod resource and can be useful for debugging.
startingDeadlineOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(10)
Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed.
This deadline specifies how much time can pass after a schedule point, for which kubernetes can still start the job. For example, if this is set to 100 seconds, kubernetes is allowed to start the job at a maximum 100 seconds after the scheduled time.
Note that the Kubernetes CronJobController checks for things every 10 seconds, for this reason, a deadline below 10 seconds is not allowed, as it may cause your job to never be scheduled.
In addition, kubernetes will stop scheduling jobs if more than 100 schedules were missed (for any reason). This property also controls what time interval should kubernetes consider when counting for missed schedules.
For example, suppose a CronJob is set to schedule a new Job every one minute beginning at 08:30:00,
and its startingDeadline field is not set. If the CronJob controller happens to be down from 08:29:00 to 10:21:00,
the job will not start as the number of missed jobs which missed their schedule is greater than 100.
However, if startingDeadline is set to 200 seconds, kubernetes will only count 3 missed schedules, and thus
start a new execution at 10:22:00.
successfulJobsRetainedOptional ¶
- Type: java.lang.Number
- Default: 3
Specifies the number of successful jobs history retained.
This would retain the Job and the associated Pod resource and can be useful for debugging.
suspendOptional ¶
- Type: java.lang.Boolean
- Default: false
Specifies if the cron job should be suspended.
Only applies to future executions, current ones are remained untouched.
timeZoneOptional ¶
- Type: java.lang.String
- Default: Timezone of kube-controller-manager process.
Specifies the timezone for the job.
This helps aligining the schedule to follow the specified timezone.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addContainer |
No description. |
addHostAlias |
No description. |
addInitContainer |
No description. |
addVolume |
No description. |
attachContainer |
No description. |
toNetworkPolicyPeerConfig |
Return the configuration of this peer. |
toPodSelector |
Convert the peer into a pod selector, if possible. |
toPodSelectorConfig |
Return the configuration of this selector. |
toSubjectConfiguration |
Return the subject configuration. |
select |
Configure selectors for this workload. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addContainer ¶
public Container addContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addHostAlias ¶
public void addHostAlias(HostAlias hostAlias)
hostAliasRequired ¶
- Type: HostAlias
addInitContainer ¶
public Container addInitContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addVolume ¶
public void addVolume(Volume vol)
volRequired ¶
- Type: Volume
attachContainer ¶
public void attachContainer(Container cont)
contRequired ¶
- Type: Container
toNetworkPolicyPeerConfig ¶
public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig()
Return the configuration of this peer.
toPodSelector ¶
public IPodSelector toPodSelector()
Convert the peer into a pod selector, if possible.
toPodSelectorConfig ¶
public PodSelectorConfig toPodSelectorConfig()
Return the configuration of this selector.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
select ¶
public void select(LabelSelector... selectors)
Configure selectors for this workload.
selectorsRequired ¶
- Type: LabelSelector…
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.CronJob;
CronJob.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
Represents the resource type. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
automountServiceAccountToken |
java.lang.Boolean |
No description. |
containers |
java.util.List<Container> |
No description. |
dns |
PodDns |
No description. |
hostAliases |
java.util.List<HostAlias> |
No description. |
initContainers |
java.util.List<Container> |
No description. |
podMetadata |
org.cdk8s.ApiObjectMetadataDefinition |
The metadata of pods in this workload. |
securityContext |
PodSecurityContext |
No description. |
shareProcessNamespace |
java.lang.Boolean |
No description. |
volumes |
java.util.List<Volume> |
No description. |
dockerRegistryAuth |
ISecret |
No description. |
enableServiceLinks |
java.lang.Boolean |
No description. |
hostNetwork |
java.lang.Boolean |
No description. |
restartPolicy |
RestartPolicy |
No description. |
serviceAccount |
IServiceAccount |
No description. |
terminationGracePeriod |
org.cdk8s.Duration |
No description. |
connections |
PodConnections |
No description. |
matchExpressions |
java.util.List<LabelSelectorRequirement> |
The expression matchers this workload will use in order to select pods. |
matchLabels |
java.util.Map |
The label matchers this workload will use in order to select pods. |
scheduling |
WorkloadScheduling |
No description. |
concurrencyPolicy |
java.lang.String |
The policy used by this cron job to determine the concurrency mode in which to schedule jobs. |
failedJobsRetained |
java.lang.Number |
The number of failed jobs retained by this cron job. |
schedule |
org.cdk8s.Cron |
The schedule this cron job is scheduled to run in. |
startingDeadline |
org.cdk8s.Duration |
The time by which the running cron job needs to schedule the next job execution. |
successfulJobsRetained |
java.lang.Number |
The number of successful jobs retained by this cron job. |
suspend |
java.lang.Boolean |
Whether or not the cron job is currently suspended or not. |
timeZone |
java.lang.String |
The timezone which this cron job would follow to schedule jobs. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
Represents the resource type.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
automountServiceAccountTokenRequired ¶
public java.lang.Boolean getAutomountServiceAccountToken();
- Type: java.lang.Boolean
containersRequired ¶
public java.util.List<Container> getContainers();
- Type: java.util.List<Container>
dnsRequired ¶
public PodDns getDns();
- Type: PodDns
hostAliasesRequired ¶
public java.util.List<HostAlias> getHostAliases();
- Type: java.util.List<HostAlias>
initContainersRequired ¶
public java.util.List<Container> getInitContainers();
- Type: java.util.List<Container>
podMetadataRequired ¶
public ApiObjectMetadataDefinition getPodMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
The metadata of pods in this workload.
securityContextRequired ¶
public PodSecurityContext getSecurityContext();
- Type: PodSecurityContext
shareProcessNamespaceRequired ¶
public java.lang.Boolean getShareProcessNamespace();
- Type: java.lang.Boolean
volumesRequired ¶
public java.util.List<Volume> getVolumes();
- Type: java.util.List<Volume>
dockerRegistryAuthOptional ¶
public ISecret getDockerRegistryAuth();
- Type: ISecret
enableServiceLinksOptional ¶
public java.lang.Boolean getEnableServiceLinks();
- Type: java.lang.Boolean
hostNetworkOptional ¶
public java.lang.Boolean getHostNetwork();
- Type: java.lang.Boolean
restartPolicyOptional ¶
public RestartPolicy getRestartPolicy();
- Type: RestartPolicy
serviceAccountOptional ¶
public IServiceAccount getServiceAccount();
- Type: IServiceAccount
terminationGracePeriodOptional ¶
public Duration getTerminationGracePeriod();
- Type: org.cdk8s.Duration
connectionsRequired ¶
public PodConnections getConnections();
- Type: PodConnections
matchExpressionsRequired ¶
public java.util.List<LabelSelectorRequirement> getMatchExpressions();
- Type: java.util.List<LabelSelectorRequirement>
The expression matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add expression matchers.
matchLabelsRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getMatchLabels();
- Type: java.util.Map
The label matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add label matchers.
schedulingRequired ¶
public WorkloadScheduling getScheduling();
- Type: WorkloadScheduling
concurrencyPolicyRequired ¶
public java.lang.String getConcurrencyPolicy();
- Type: java.lang.String
The policy used by this cron job to determine the concurrency mode in which to schedule jobs.
failedJobsRetainedRequired ¶
public java.lang.Number getFailedJobsRetained();
- Type: java.lang.Number
The number of failed jobs retained by this cron job.
scheduleRequired ¶
public Cron getSchedule();
- Type: org.cdk8s.Cron
The schedule this cron job is scheduled to run in.
startingDeadlineRequired ¶
public Duration getStartingDeadline();
- Type: org.cdk8s.Duration
The time by which the running cron job needs to schedule the next job execution.
The job is considered as failed if it misses this deadline.
successfulJobsRetainedRequired ¶
public java.lang.Number getSuccessfulJobsRetained();
- Type: java.lang.Number
The number of successful jobs retained by this cron job.
suspendRequired ¶
public java.lang.Boolean getSuspend();
- Type: java.lang.Boolean
Whether or not the cron job is currently suspended or not.
timeZoneOptional ¶
public java.lang.String getTimeZone();
- Type: java.lang.String
The timezone which this cron job would follow to schedule jobs.
DaemonSet ¶
A DaemonSet ensures that all (or some) Nodes run a copy of a Pod.
As nodes are added to the cluster, Pods are added to them. As nodes are removed from the cluster, those Pods are garbage collected. Deleting a DaemonSet will clean up the Pods it created.
Some typical uses of a DaemonSet are:
- running a cluster storage daemon on every node
- running a logs collection daemon on every node
- running a node monitoring daemon on every node
In a simple case, one DaemonSet, covering all nodes, would be used for each type of daemon. A more complex setup might use multiple DaemonSets for a single type of daemon, but with different flags and/or different memory and cpu requests for different hardware types.
Initializers ¶
import org.cdk8s.plus36.DaemonSet;
DaemonSet.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .automountServiceAccountToken(java.lang.Boolean)
// .containers(java.util.List<ContainerProps>)
// .dns(PodDnsProps)
// .dockerRegistryAuth(ISecret)
// .enableServiceLinks(java.lang.Boolean)
// .hostAliases(java.util.List<HostAlias>)
// .hostNetwork(java.lang.Boolean)
// .initContainers(java.util.List<ContainerProps>)
// .isolate(java.lang.Boolean)
// .restartPolicy(RestartPolicy)
// .securityContext(PodSecurityContextProps)
// .serviceAccount(IServiceAccount)
// .shareProcessNamespace(java.lang.Boolean)
// .terminationGracePeriod(Duration)
// .volumes(java.util.List<Volume>)
// .podMetadata(ApiObjectMetadata)
// .select(java.lang.Boolean)
// .spread(java.lang.Boolean)
// .minReadySeconds(java.lang.Number)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
automountServiceAccountToken |
java.lang.Boolean |
Indicates whether a service account token should be automatically mounted. |
containers |
java.util.List<ContainerProps> |
List of containers belonging to the pod. |
dns |
PodDnsProps |
DNS settings for the pod. |
dockerRegistryAuth |
ISecret |
A secret containing docker credentials for authenticating to a registry. |
enableServiceLinks |
java.lang.Boolean |
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. |
hostAliases |
java.util.List<HostAlias> |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
hostNetwork |
java.lang.Boolean |
Host network for the pod. |
initContainers |
java.util.List<ContainerProps> |
List of initialization containers belonging to the pod. |
isolate |
java.lang.Boolean |
Isolates the pod. |
restartPolicy |
RestartPolicy |
Restart policy for all containers within the pod. |
securityContext |
PodSecurityContextProps |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccount |
IServiceAccount |
A service account provides an identity for processes that run in a Pod. |
shareProcessNamespace |
java.lang.Boolean |
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. |
terminationGracePeriod |
org.cdk8s.Duration |
Grace period until the pod is terminated. |
volumes |
java.util.List<Volume> |
List of volumes that can be mounted by containers belonging to the pod. |
podMetadata |
org.cdk8s.ApiObjectMetadata |
The pod metadata of this workload. |
select |
java.lang.Boolean |
Automatically allocates a pod label selector for this workload and add it to the pod metadata. |
spread |
java.lang.Boolean |
Automatically spread pods across hostname and zones. |
minReadySeconds |
java.lang.Number |
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. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
- Default: false
Indicates whether a service account token should be automatically mounted.
containersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No containers. Note that a pod spec must include at least one container.
List of containers belonging to the pod.
Containers cannot currently be added or removed. There must be at least one container in a Pod.
You can add additionnal containers using podSpec.addContainer()
dnsOptional ¶
- Type: PodDnsProps
- Default: policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false
DNS settings for the pod.
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
dockerRegistryAuthOptional ¶
- Type: ISecret
- Default: No auth. Images are assumed to be publicly available.
A secret containing docker credentials for authenticating to a registry.
enableServiceLinksOptional ¶
- Type: java.lang.Boolean
- Default: true
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links.
hostAliasesOptional ¶
- Type: java.util.List<HostAlias>
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
hostNetworkOptional ¶
- Type: java.lang.Boolean
- Default: false
Host network for the pod.
initContainersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No init containers.
List of initialization containers belonging to the pod.
Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.
Init containers cannot currently be added ,removed or updated.
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
isolateOptional ¶
- Type: java.lang.Boolean
- Default: false
Isolates the pod.
This will prevent any ingress or egress connections to / from this pod.
You can however allow explicit connections post instantiation by using the .connections property.
restartPolicyOptional ¶
- Type: RestartPolicy
- Default: RestartPolicy.ALWAYS
Restart policy for all containers within the pod.
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
securityContextOptional ¶
- Type: PodSecurityContextProps
- Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true
SecurityContext holds pod-level security attributes and common container settings.
serviceAccountOptional ¶
- Type: IServiceAccount
- Default: No service account.
A service account provides an identity for processes that run in a Pod.
When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespaceOptional ¶
- Type: java.lang.Boolean
- Default: false
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.
https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
terminationGracePeriodOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(30)
Grace period until the pod is terminated.
volumesOptional ¶
- Type: java.util.List<Volume>
- Default: No volumes.
List of volumes that can be mounted by containers belonging to the pod.
You can also add volumes later using podSpec.addVolume()
podMetadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
The pod metadata of this workload.
selectOptional ¶
- Type: java.lang.Boolean
- Default: true
Automatically allocates a pod label selector for this workload and add it to the pod metadata.
This ensures this workload manages pods created by its pod template.
spreadOptional ¶
- Type: java.lang.Boolean
- Default: false
Automatically spread pods across hostname and zones.
minReadySecondsOptional ¶
- Type: java.lang.Number
- Default: 0
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.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addContainer |
No description. |
addHostAlias |
No description. |
addInitContainer |
No description. |
addVolume |
No description. |
attachContainer |
No description. |
toNetworkPolicyPeerConfig |
Return the configuration of this peer. |
toPodSelector |
Convert the peer into a pod selector, if possible. |
toPodSelectorConfig |
Return the configuration of this selector. |
toSubjectConfiguration |
Return the subject configuration. |
select |
Configure selectors for this workload. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addContainer ¶
public Container addContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addHostAlias ¶
public void addHostAlias(HostAlias hostAlias)
hostAliasRequired ¶
- Type: HostAlias
addInitContainer ¶
public Container addInitContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addVolume ¶
public void addVolume(Volume vol)
volRequired ¶
- Type: Volume
attachContainer ¶
public void attachContainer(Container cont)
contRequired ¶
- Type: Container
toNetworkPolicyPeerConfig ¶
public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig()
Return the configuration of this peer.
toPodSelector ¶
public IPodSelector toPodSelector()
Convert the peer into a pod selector, if possible.
toPodSelectorConfig ¶
public PodSelectorConfig toPodSelectorConfig()
Return the configuration of this selector.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
select ¶
public void select(LabelSelector... selectors)
Configure selectors for this workload.
selectorsRequired ¶
- Type: LabelSelector…
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.DaemonSet;
DaemonSet.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
automountServiceAccountToken |
java.lang.Boolean |
No description. |
containers |
java.util.List<Container> |
No description. |
dns |
PodDns |
No description. |
hostAliases |
java.util.List<HostAlias> |
No description. |
initContainers |
java.util.List<Container> |
No description. |
podMetadata |
org.cdk8s.ApiObjectMetadataDefinition |
The metadata of pods in this workload. |
securityContext |
PodSecurityContext |
No description. |
shareProcessNamespace |
java.lang.Boolean |
No description. |
volumes |
java.util.List<Volume> |
No description. |
dockerRegistryAuth |
ISecret |
No description. |
enableServiceLinks |
java.lang.Boolean |
No description. |
hostNetwork |
java.lang.Boolean |
No description. |
restartPolicy |
RestartPolicy |
No description. |
serviceAccount |
IServiceAccount |
No description. |
terminationGracePeriod |
org.cdk8s.Duration |
No description. |
connections |
PodConnections |
No description. |
matchExpressions |
java.util.List<LabelSelectorRequirement> |
The expression matchers this workload will use in order to select pods. |
matchLabels |
java.util.Map |
The label matchers this workload will use in order to select pods. |
scheduling |
WorkloadScheduling |
No description. |
minReadySeconds |
java.lang.Number |
No description. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
automountServiceAccountTokenRequired ¶
public java.lang.Boolean getAutomountServiceAccountToken();
- Type: java.lang.Boolean
containersRequired ¶
public java.util.List<Container> getContainers();
- Type: java.util.List<Container>
dnsRequired ¶
public PodDns getDns();
- Type: PodDns
hostAliasesRequired ¶
public java.util.List<HostAlias> getHostAliases();
- Type: java.util.List<HostAlias>
initContainersRequired ¶
public java.util.List<Container> getInitContainers();
- Type: java.util.List<Container>
podMetadataRequired ¶
public ApiObjectMetadataDefinition getPodMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
The metadata of pods in this workload.
securityContextRequired ¶
public PodSecurityContext getSecurityContext();
- Type: PodSecurityContext
shareProcessNamespaceRequired ¶
public java.lang.Boolean getShareProcessNamespace();
- Type: java.lang.Boolean
volumesRequired ¶
public java.util.List<Volume> getVolumes();
- Type: java.util.List<Volume>
dockerRegistryAuthOptional ¶
public ISecret getDockerRegistryAuth();
- Type: ISecret
enableServiceLinksOptional ¶
public java.lang.Boolean getEnableServiceLinks();
- Type: java.lang.Boolean
hostNetworkOptional ¶
public java.lang.Boolean getHostNetwork();
- Type: java.lang.Boolean
restartPolicyOptional ¶
public RestartPolicy getRestartPolicy();
- Type: RestartPolicy
serviceAccountOptional ¶
public IServiceAccount getServiceAccount();
- Type: IServiceAccount
terminationGracePeriodOptional ¶
public Duration getTerminationGracePeriod();
- Type: org.cdk8s.Duration
connectionsRequired ¶
public PodConnections getConnections();
- Type: PodConnections
matchExpressionsRequired ¶
public java.util.List<LabelSelectorRequirement> getMatchExpressions();
- Type: java.util.List<LabelSelectorRequirement>
The expression matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add expression matchers.
matchLabelsRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getMatchLabels();
- Type: java.util.Map
The label matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add label matchers.
schedulingRequired ¶
public WorkloadScheduling getScheduling();
- Type: WorkloadScheduling
minReadySecondsRequired ¶
public java.lang.Number getMinReadySeconds();
- Type: java.lang.Number
Deployment ¶
- Implements: IScalable
A Deployment provides declarative updates for Pods and ReplicaSets.
You describe a desired state in a Deployment, and the Deployment Controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.
Note: Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.
Use Case
The following are typical use cases for Deployments:
- Create a Deployment to rollout a ReplicaSet. The ReplicaSet creates Pods in the background. Check the status of the rollout to see if it succeeds or not.
- Declare the new state of the Pods by updating the PodTemplateSpec of the Deployment. A new ReplicaSet is created and the Deployment manages moving the Pods from the old ReplicaSet to the new one at a controlled rate. Each new ReplicaSet updates the revision of the Deployment.
- Rollback to an earlier Deployment revision if the current state of the Deployment is not stable. Each rollback updates the revision of the Deployment.
- Scale up the Deployment to facilitate more load.
- Pause the Deployment to apply multiple fixes to its PodTemplateSpec and then resume it to start a new rollout.
- Use the status of the Deployment as an indicator that a rollout has stuck.
- Clean up older ReplicaSets that you don’t need anymore.
Initializers ¶
import org.cdk8s.plus36.Deployment;
Deployment.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .automountServiceAccountToken(java.lang.Boolean)
// .containers(java.util.List<ContainerProps>)
// .dns(PodDnsProps)
// .dockerRegistryAuth(ISecret)
// .enableServiceLinks(java.lang.Boolean)
// .hostAliases(java.util.List<HostAlias>)
// .hostNetwork(java.lang.Boolean)
// .initContainers(java.util.List<ContainerProps>)
// .isolate(java.lang.Boolean)
// .restartPolicy(RestartPolicy)
// .securityContext(PodSecurityContextProps)
// .serviceAccount(IServiceAccount)
// .shareProcessNamespace(java.lang.Boolean)
// .terminationGracePeriod(Duration)
// .volumes(java.util.List<Volume>)
// .podMetadata(ApiObjectMetadata)
// .select(java.lang.Boolean)
// .spread(java.lang.Boolean)
// .minReady(Duration)
// .progressDeadline(Duration)
// .replicas(java.lang.Number)
// .revisionHistoryLimit(java.lang.Number)
// .strategy(DeploymentStrategy)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
automountServiceAccountToken |
java.lang.Boolean |
Indicates whether a service account token should be automatically mounted. |
containers |
java.util.List<ContainerProps> |
List of containers belonging to the pod. |
dns |
PodDnsProps |
DNS settings for the pod. |
dockerRegistryAuth |
ISecret |
A secret containing docker credentials for authenticating to a registry. |
enableServiceLinks |
java.lang.Boolean |
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. |
hostAliases |
java.util.List<HostAlias> |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
hostNetwork |
java.lang.Boolean |
Host network for the pod. |
initContainers |
java.util.List<ContainerProps> |
List of initialization containers belonging to the pod. |
isolate |
java.lang.Boolean |
Isolates the pod. |
restartPolicy |
RestartPolicy |
Restart policy for all containers within the pod. |
securityContext |
PodSecurityContextProps |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccount |
IServiceAccount |
A service account provides an identity for processes that run in a Pod. |
shareProcessNamespace |
java.lang.Boolean |
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. |
terminationGracePeriod |
org.cdk8s.Duration |
Grace period until the pod is terminated. |
volumes |
java.util.List<Volume> |
List of volumes that can be mounted by containers belonging to the pod. |
podMetadata |
org.cdk8s.ApiObjectMetadata |
The pod metadata of this workload. |
select |
java.lang.Boolean |
Automatically allocates a pod label selector for this workload and add it to the pod metadata. |
spread |
java.lang.Boolean |
Automatically spread pods across hostname and zones. |
minReady |
org.cdk8s.Duration |
Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available. |
progressDeadline |
org.cdk8s.Duration |
The maximum duration for a deployment to make progress before it is considered to be failed. |
replicas |
java.lang.Number |
Number of desired pods. |
revisionHistoryLimit |
java.lang.Number |
Specify how many old ReplicaSets for this Deployment you want to retain. |
strategy |
DeploymentStrategy |
Specifies the strategy used to replace old Pods by new ones. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
- Default: false
Indicates whether a service account token should be automatically mounted.
containersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No containers. Note that a pod spec must include at least one container.
List of containers belonging to the pod.
Containers cannot currently be added or removed. There must be at least one container in a Pod.
You can add additionnal containers using podSpec.addContainer()
dnsOptional ¶
- Type: PodDnsProps
- Default: policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false
DNS settings for the pod.
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
dockerRegistryAuthOptional ¶
- Type: ISecret
- Default: No auth. Images are assumed to be publicly available.
A secret containing docker credentials for authenticating to a registry.
enableServiceLinksOptional ¶
- Type: java.lang.Boolean
- Default: true
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links.
hostAliasesOptional ¶
- Type: java.util.List<HostAlias>
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
hostNetworkOptional ¶
- Type: java.lang.Boolean
- Default: false
Host network for the pod.
initContainersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No init containers.
List of initialization containers belonging to the pod.
Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.
Init containers cannot currently be added ,removed or updated.
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
isolateOptional ¶
- Type: java.lang.Boolean
- Default: false
Isolates the pod.
This will prevent any ingress or egress connections to / from this pod.
You can however allow explicit connections post instantiation by using the .connections property.
restartPolicyOptional ¶
- Type: RestartPolicy
- Default: RestartPolicy.ALWAYS
Restart policy for all containers within the pod.
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
securityContextOptional ¶
- Type: PodSecurityContextProps
- Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true
SecurityContext holds pod-level security attributes and common container settings.
serviceAccountOptional ¶
- Type: IServiceAccount
- Default: No service account.
A service account provides an identity for processes that run in a Pod.
When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespaceOptional ¶
- Type: java.lang.Boolean
- Default: false
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.
https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
terminationGracePeriodOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(30)
Grace period until the pod is terminated.
volumesOptional ¶
- Type: java.util.List<Volume>
- Default: No volumes.
List of volumes that can be mounted by containers belonging to the pod.
You can also add volumes later using podSpec.addVolume()
podMetadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
The pod metadata of this workload.
selectOptional ¶
- Type: java.lang.Boolean
- Default: true
Automatically allocates a pod label selector for this workload and add it to the pod metadata.
This ensures this workload manages pods created by its pod template.
spreadOptional ¶
- Type: java.lang.Boolean
- Default: false
Automatically spread pods across hostname and zones.
minReadyOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(0)
Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
Zero means the pod will be considered available as soon as it is ready.
https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds
progressDeadlineOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(600)
The maximum duration for a deployment to make progress before it is considered to be failed.
The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status.
Note that progress will not be estimated during the time a deployment is paused.
https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds
replicasOptional ¶
- Type: java.lang.Number
- Default: 2
Number of desired pods.
revisionHistoryLimitOptional ¶
- Type: java.lang.Number
- Default: 10
Specify how many old ReplicaSets for this Deployment you want to retain.
The rest will be garbage-collected in the background. By default, it is 10.
strategyOptional ¶
- Type: DeploymentStrategy
- Default: RollingUpdate with maxSurge and maxUnavailable set to 25%.
Specifies the strategy used to replace old Pods by new ones.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addContainer |
No description. |
addHostAlias |
No description. |
addInitContainer |
No description. |
addVolume |
No description. |
attachContainer |
No description. |
toNetworkPolicyPeerConfig |
Return the configuration of this peer. |
toPodSelector |
Convert the peer into a pod selector, if possible. |
toPodSelectorConfig |
Return the configuration of this selector. |
toSubjectConfiguration |
Return the subject configuration. |
select |
Configure selectors for this workload. |
exposeViaIngress |
Expose a deployment via an ingress. |
exposeViaService |
Expose a deployment via a service. |
markHasAutoscaler |
Called on all IScalable targets when they are associated with an autoscaler. |
toScalingTarget |
Return the target spec properties of this Scalable. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addContainer ¶
public Container addContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addHostAlias ¶
public void addHostAlias(HostAlias hostAlias)
hostAliasRequired ¶
- Type: HostAlias
addInitContainer ¶
public Container addInitContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addVolume ¶
public void addVolume(Volume vol)
volRequired ¶
- Type: Volume
attachContainer ¶
public void attachContainer(Container cont)
contRequired ¶
- Type: Container
toNetworkPolicyPeerConfig ¶
public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig()
Return the configuration of this peer.
toPodSelector ¶
public IPodSelector toPodSelector()
Convert the peer into a pod selector, if possible.
toPodSelectorConfig ¶
public PodSelectorConfig toPodSelectorConfig()
Return the configuration of this selector.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
select ¶
public void select(LabelSelector... selectors)
Configure selectors for this workload.
selectorsRequired ¶
- Type: LabelSelector…
exposeViaIngress ¶
public Ingress exposeViaIngress(java.lang.String path)
public Ingress exposeViaIngress(java.lang.String path, ExposeDeploymentViaIngressOptions options)
Expose a deployment via an ingress.
This will first expose the deployment with a service, and then expose the service via an ingress.
pathRequired ¶
- Type: java.lang.String
The ingress path to register under.
optionsOptional ¶
Additional options.
exposeViaService ¶
public Service exposeViaService()
public Service exposeViaService(DeploymentExposeViaServiceOptions options)
Expose a deployment via a service.
This is equivalent to running kubectl expose deployment <deployment-name>.
optionsOptional ¶
Options to determine details of the service and port exposed.
markHasAutoscaler ¶
public void markHasAutoscaler()
Called on all IScalable targets when they are associated with an autoscaler.
toScalingTarget ¶
public ScalingTarget toScalingTarget()
Return the target spec properties of this Scalable.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.Deployment;
Deployment.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
automountServiceAccountToken |
java.lang.Boolean |
No description. |
containers |
java.util.List<Container> |
No description. |
dns |
PodDns |
No description. |
hostAliases |
java.util.List<HostAlias> |
No description. |
initContainers |
java.util.List<Container> |
No description. |
podMetadata |
org.cdk8s.ApiObjectMetadataDefinition |
The metadata of pods in this workload. |
securityContext |
PodSecurityContext |
No description. |
shareProcessNamespace |
java.lang.Boolean |
No description. |
volumes |
java.util.List<Volume> |
No description. |
dockerRegistryAuth |
ISecret |
No description. |
enableServiceLinks |
java.lang.Boolean |
No description. |
hostNetwork |
java.lang.Boolean |
No description. |
restartPolicy |
RestartPolicy |
No description. |
serviceAccount |
IServiceAccount |
No description. |
terminationGracePeriod |
org.cdk8s.Duration |
No description. |
connections |
PodConnections |
No description. |
matchExpressions |
java.util.List<LabelSelectorRequirement> |
The expression matchers this workload will use in order to select pods. |
matchLabels |
java.util.Map |
The label matchers this workload will use in order to select pods. |
scheduling |
WorkloadScheduling |
No description. |
minReady |
org.cdk8s.Duration |
Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available. |
progressDeadline |
org.cdk8s.Duration |
The maximum duration for a deployment to make progress before it is considered to be failed. |
revisionHistoryLimit |
java.lang.Number |
Number of desired replicasets history. |
strategy |
DeploymentStrategy |
No description. |
replicas |
java.lang.Number |
Number of desired pods. |
hasAutoscaler |
java.lang.Boolean |
If this is a target of an autoscaler. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
automountServiceAccountTokenRequired ¶
public java.lang.Boolean getAutomountServiceAccountToken();
- Type: java.lang.Boolean
containersRequired ¶
public java.util.List<Container> getContainers();
- Type: java.util.List<Container>
dnsRequired ¶
public PodDns getDns();
- Type: PodDns
hostAliasesRequired ¶
public java.util.List<HostAlias> getHostAliases();
- Type: java.util.List<HostAlias>
initContainersRequired ¶
public java.util.List<Container> getInitContainers();
- Type: java.util.List<Container>
podMetadataRequired ¶
public ApiObjectMetadataDefinition getPodMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
The metadata of pods in this workload.
securityContextRequired ¶
public PodSecurityContext getSecurityContext();
- Type: PodSecurityContext
shareProcessNamespaceRequired ¶
public java.lang.Boolean getShareProcessNamespace();
- Type: java.lang.Boolean
volumesRequired ¶
public java.util.List<Volume> getVolumes();
- Type: java.util.List<Volume>
dockerRegistryAuthOptional ¶
public ISecret getDockerRegistryAuth();
- Type: ISecret
enableServiceLinksOptional ¶
public java.lang.Boolean getEnableServiceLinks();
- Type: java.lang.Boolean
hostNetworkOptional ¶
public java.lang.Boolean getHostNetwork();
- Type: java.lang.Boolean
restartPolicyOptional ¶
public RestartPolicy getRestartPolicy();
- Type: RestartPolicy
serviceAccountOptional ¶
public IServiceAccount getServiceAccount();
- Type: IServiceAccount
terminationGracePeriodOptional ¶
public Duration getTerminationGracePeriod();
- Type: org.cdk8s.Duration
connectionsRequired ¶
public PodConnections getConnections();
- Type: PodConnections
matchExpressionsRequired ¶
public java.util.List<LabelSelectorRequirement> getMatchExpressions();
- Type: java.util.List<LabelSelectorRequirement>
The expression matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add expression matchers.
matchLabelsRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getMatchLabels();
- Type: java.util.Map
The label matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add label matchers.
schedulingRequired ¶
public WorkloadScheduling getScheduling();
- Type: WorkloadScheduling
minReadyRequired ¶
public Duration getMinReady();
- Type: org.cdk8s.Duration
Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
progressDeadlineRequired ¶
public Duration getProgressDeadline();
- Type: org.cdk8s.Duration
The maximum duration for a deployment to make progress before it is considered to be failed.
revisionHistoryLimitRequired ¶
public java.lang.Number getRevisionHistoryLimit();
- Type: java.lang.Number
- Default: 10
Number of desired replicasets history.
strategyRequired ¶
public DeploymentStrategy getStrategy();
- Type: DeploymentStrategy
replicasOptional ¶
public java.lang.Number getReplicas();
- Type: java.lang.Number
Number of desired pods.
hasAutoscalerRequired ¶
public java.lang.Boolean getHasAutoscaler();
- Type: java.lang.Boolean
If this is a target of an autoscaler.
DockerConfigSecret ¶
Create a secret for storing credentials for accessing a container image registry.
https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets
Initializers ¶
import org.cdk8s.plus36.DockerConfigSecret;
DockerConfigSecret.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .immutable(java.lang.Boolean)
.data(java.util.Map<java.lang.String, java.lang.Object>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
immutable |
java.lang.Boolean |
If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). |
data |
java.util.Map |
JSON content to provide for the ~/.docker/config.json file. This will be stringified and inserted as stringData. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
immutableOptional ¶
- Type: java.lang.Boolean
- Default: false
If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).
If not set to true, the field can be modified at any time.
dataRequired ¶
- Type: java.util.Map
JSON content to provide for the ~/.docker/config.json file. This will be stringified and inserted as stringData.
https://docs.docker.com/engine/reference/commandline/cli/#sample-configuration-file
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addStringData |
Adds a string data field to the secret. |
envValue |
Returns EnvValue object from a secret’s key. |
getStringData |
Gets a string data by key or undefined. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addStringData ¶
public void addStringData(java.lang.String key, java.lang.String value)
Adds a string data field to the secret.
keyRequired ¶
- Type: java.lang.String
Key.
valueRequired ¶
- Type: java.lang.String
Value.
envValue ¶
public EnvValue envValue(java.lang.String key)
public EnvValue envValue(java.lang.String key, EnvValueFromSecretOptions options)
Returns EnvValue object from a secret’s key.
keyRequired ¶
- Type: java.lang.String
optionsOptional ¶
getStringData ¶
public java.lang.String getStringData(java.lang.String key)
Gets a string data by key or undefined.
keyRequired ¶
- Type: java.lang.String
Key.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromSecretName |
Imports a secret from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.DockerConfigSecret;
DockerConfigSecret.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromSecretName ¶
import org.cdk8s.plus36.DockerConfigSecret;
DockerConfigSecret.fromSecretName(Construct scope, java.lang.String id, java.lang.String name)
Imports a secret from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
nameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
immutable |
java.lang.Boolean |
Whether or not the secret is immutable. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
immutableRequired ¶
public java.lang.Boolean getImmutable();
- Type: java.lang.Boolean
Whether or not the secret is immutable.
GCEPersistentDiskPersistentVolume ¶
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod.
Provisioned by an admin.
https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
Initializers ¶
import org.cdk8s.plus36.GCEPersistentDiskPersistentVolume;
GCEPersistentDiskPersistentVolume.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .accessModes(java.util.List<PersistentVolumeAccessMode>)
// .claim(IPersistentVolumeClaim)
// .mountOptions(java.util.List<java.lang.String>)
// .reclaimPolicy(PersistentVolumeReclaimPolicy)
// .storage(Size)
// .storageClassName(java.lang.String)
// .volumeMode(PersistentVolumeMode)
.pdName(java.lang.String)
// .fsType(java.lang.String)
// .partition(java.lang.Number)
// .readOnly(java.lang.Boolean)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Contains all ways the volume can be mounted. |
claim |
IPersistentVolumeClaim |
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. |
mountOptions |
java.util.List |
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. |
storage |
org.cdk8s.Size |
What is the storage capacity of this volume. |
storageClassName |
java.lang.String |
Name of StorageClass to which this persistent volume belongs. |
volumeMode |
PersistentVolumeMode |
Defines what type of volume is required by the claim. |
pdName |
java.lang.String |
Unique name of the PD resource in GCE. |
fsType |
java.lang.String |
Filesystem type of the volume that you want to mount. |
partition |
java.lang.Number |
The partition in the volume that you want to mount. |
readOnly |
java.lang.Boolean |
Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
accessModesOptional ¶
- Type: java.util.List<PersistentVolumeAccessMode>
- Default: No access modes.
Contains all ways the volume can be mounted.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
claimOptional ¶
- Type: IPersistentVolumeClaim
- Default: Not bound to a specific claim.
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
Expected to be non-nil when bound.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
mountOptionsOptional ¶
- Type: java.util.List
- Default: No options.
A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
reclaimPolicyOptional ¶
- Type: PersistentVolumeReclaimPolicy
- Default: PersistentVolumeReclaimPolicy.RETAIN
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.
The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
storageOptional ¶
- Type: org.cdk8s.Size
- Default: No specified.
What is the storage capacity of this volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
storageClassNameOptional ¶
- Type: java.lang.String
- Default: Volume does not belong to any storage class.
Name of StorageClass to which this persistent volume belongs.
volumeModeOptional ¶
- Type: PersistentVolumeMode
- Default: VolumeMode.FILE_SYSTEM
Defines what type of volume is required by the claim.
pdNameRequired ¶
- Type: java.lang.String
Unique name of the PD resource in GCE.
Used to identify the disk in GCE.
https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
fsTypeOptional ¶
- Type: java.lang.String
- Default: ‘ext4’
Filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partitionOptional ¶
- Type: java.lang.Number
- Default: No partition.
The partition in the volume that you want to mount.
If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty).
readOnlyOptional ¶
- Type: java.lang.Boolean
- Default: false
Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.
https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
asVolume |
Convert the piece of storage into a concrete volume. |
bind |
Bind a volume to a specific claim. |
reserve |
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
asVolume ¶
public Volume asVolume()
Convert the piece of storage into a concrete volume.
bind ¶
public void bind(IPersistentVolumeClaim claim)
Bind a volume to a specific claim.
Note that you must also bind the claim to the volume.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding
claimRequired ¶
- Type: IPersistentVolumeClaim
The PVC to bind to.
reserve ¶
public PersistentVolumeClaim reserve()
Reserve a PersistentVolume by creating a PersistentVolumeClaim that is wired to claim this volume.
Note that this method will throw in case the volume is already claimed.
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromPersistentVolumeName |
Imports a pv from the cluster as a reference. |
isConstruct ¶
import org.cdk8s.plus36.GCEPersistentDiskPersistentVolume;
GCEPersistentDiskPersistentVolume.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromPersistentVolumeName ¶
import org.cdk8s.plus36.GCEPersistentDiskPersistentVolume;
GCEPersistentDiskPersistentVolume.fromPersistentVolumeName(Construct scope, java.lang.String id, java.lang.String volumeName)
Imports a pv from the cluster as a reference.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
volumeNameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
mode |
PersistentVolumeMode |
Volume mode of this volume. |
reclaimPolicy |
PersistentVolumeReclaimPolicy |
Reclaim policy of this volume. |
accessModes |
java.util.List<PersistentVolumeAccessMode> |
Access modes requirement of this claim. |
claim |
IPersistentVolumeClaim |
PVC this volume is bound to. |
mountOptions |
java.util.List |
Mount options of this volume. |
storage |
org.cdk8s.Size |
Storage size of this volume. |
storageClassName |
java.lang.String |
Storage class this volume belongs to. |
fsType |
java.lang.String |
File system type of this volume. |
pdName |
java.lang.String |
PD resource in GCE of this volume. |
readOnly |
java.lang.Boolean |
Whether or not it is mounted as a read-only volume. |
partition |
java.lang.Number |
Partition of this volume. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
modeRequired ¶
public PersistentVolumeMode getMode();
- Type: PersistentVolumeMode
Volume mode of this volume.
reclaimPolicyRequired ¶
public PersistentVolumeReclaimPolicy getReclaimPolicy();
Reclaim policy of this volume.
accessModesOptional ¶
public java.util.List<PersistentVolumeAccessMode> getAccessModes();
- Type: java.util.List<PersistentVolumeAccessMode>
Access modes requirement of this claim.
claimOptional ¶
public IPersistentVolumeClaim getClaim();
- Type: IPersistentVolumeClaim
PVC this volume is bound to.
Undefined means this volume is not yet claimed by any PVC.
mountOptionsOptional ¶
public java.util.List<java.lang.String> getMountOptions();
- Type: java.util.List
Mount options of this volume.
storageOptional ¶
public Size getStorage();
- Type: org.cdk8s.Size
Storage size of this volume.
storageClassNameOptional ¶
public java.lang.String getStorageClassName();
- Type: java.lang.String
Storage class this volume belongs to.
fsTypeRequired ¶
public java.lang.String getFsType();
- Type: java.lang.String
File system type of this volume.
pdNameRequired ¶
public java.lang.String getPdName();
- Type: java.lang.String
PD resource in GCE of this volume.
readOnlyRequired ¶
public java.lang.Boolean getReadOnly();
- Type: java.lang.Boolean
Whether or not it is mounted as a read-only volume.
partitionOptional ¶
public java.lang.Number getPartition();
- Type: java.lang.Number
Partition of this volume.
Group ¶
- Implements: ISubject
Represents a group.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
toSubjectConfiguration |
Return the subject configuration. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
fromName |
Reference a group by name. |
isConstruct ¶
import org.cdk8s.plus36.Group;
Group.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
fromName ¶
import org.cdk8s.plus36.Group;
Group.fromName(Construct scope, java.lang.String id, java.lang.String name)
Reference a group by name.
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
nameRequired ¶
- Type: java.lang.String
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
kind |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
apiGroup |
java.lang.String |
No description. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
apiGroupOptional ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
HorizontalPodAutoscaler ¶
A HorizontalPodAutoscaler scales a workload up or down in response to a metric change.
This allows your services to scale up when demand is high and scale down when they are no longer needed.
Typical use cases for HorizontalPodAutoscaler:
- When Memory usage is above 70%, scale up the number of replicas to meet the demand.
- When CPU usage is below 30%, scale down the number of replicas to save resources.
- When a service is experiencing a spike in traffic, scale up the number of replicas to meet the demand. Then, when the traffic subsides, scale down the number of replicas to save resources.
The autoscaler uses the following algorithm to determine the number of replicas to scale:
desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricValue )]
HorizontalPodAutoscaler’s can be used to with any Scalable workload:
- Deployment
- StatefulSet
Targets that already have a replica count defined:
Remove any replica counts from the target resource before associating with a HorizontalPodAutoscaler. If this isn’t done, then any time a change to that object is applied, Kubernetes will scale the current number of Pods to the value of the target.replicas key. This may not be desired and could lead to unexpected behavior.
Example
// Example automatically generated from non-compiling source. May contain errors.
Object backend = new Deployment(this, "Backend", ...);
Object hpa = HorizontalPodAutoscaler.Builder.create(chart, "Hpa")
.target(backend)
.maxReplicas(10)
.scaleUp(Map.of(
"policies", List.of(Map.of(
"replicas", kplus.Replicas.absolute(3),
"duration", Duration.minutes(5)))))
.build();
Initializers ¶
import org.cdk8s.plus36.HorizontalPodAutoscaler;
HorizontalPodAutoscaler.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
.maxReplicas(java.lang.Number)
.target(IScalable)
// .metrics(java.util.List<Metric>)
// .minReplicas(java.lang.Number)
// .scaleDown(ScalingRules)
// .scaleUp(ScalingRules)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
maxReplicas |
java.lang.Number |
The maximum number of replicas that can be scaled up to. |
target |
IScalable |
The workload to scale up or down. |
metrics |
java.util.List<Metric> |
The metric conditions that trigger a scale up or scale down. |
minReplicas |
java.lang.Number |
The minimum number of replicas that can be scaled down to. |
scaleDown |
ScalingRules |
The scaling behavior when scaling down. |
scaleUp |
ScalingRules |
The scaling behavior when scaling up. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
maxReplicasRequired ¶
- Type: java.lang.Number
The maximum number of replicas that can be scaled up to.
targetRequired ¶
- Type: IScalable
The workload to scale up or down.
Scalable workload types:
- Deployment
- StatefulSet
metricsOptional ¶
- Type: java.util.List<Metric>
- Default: If metrics are not provided, then the target resource constraints (e.g. cpu limit) will be used as scaling metrics.
The metric conditions that trigger a scale up or scale down.
minReplicasOptional ¶
- Type: java.lang.Number
- Default: 1
The minimum number of replicas that can be scaled down to.
Can be set to 0 if the alpha feature gate HPAScaleToZero is enabled and
at least one Object or External metric is configured.
scaleDownOptional ¶
- Type: ScalingRules
- Default: Scale down to minReplica count with a 5 minute stabilization window.
The scaling behavior when scaling down.
scaleUpOptional ¶
- Type: ScalingRules
- Default: Is the higher of: * Increase no more than 4 pods per 60 seconds * Double the number of pods per 60 seconds
The scaling behavior when scaling up.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.HorizontalPodAutoscaler;
HorizontalPodAutoscaler.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
maxReplicas |
java.lang.Number |
The maximum number of replicas that can be scaled up to. |
minReplicas |
java.lang.Number |
The minimum number of replicas that can be scaled down to. |
scaleDown |
ScalingRules |
The scaling behavior when scaling down. |
scaleUp |
ScalingRules |
The scaling behavior when scaling up. |
target |
IScalable |
The workload to scale up or down. |
metrics |
java.util.List<Metric> |
The metric conditions that trigger a scale up or scale down. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
maxReplicasRequired ¶
public java.lang.Number getMaxReplicas();
- Type: java.lang.Number
The maximum number of replicas that can be scaled up to.
minReplicasRequired ¶
public java.lang.Number getMinReplicas();
- Type: java.lang.Number
The minimum number of replicas that can be scaled down to.
scaleDownRequired ¶
public ScalingRules getScaleDown();
- Type: ScalingRules
The scaling behavior when scaling down.
scaleUpRequired ¶
public ScalingRules getScaleUp();
- Type: ScalingRules
The scaling behavior when scaling up.
targetRequired ¶
public IScalable getTarget();
- Type: IScalable
The workload to scale up or down.
metricsOptional ¶
public java.util.List<Metric> getMetrics();
- Type: java.util.List<Metric>
The metric conditions that trigger a scale up or scale down.
Ingress ¶
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.
An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
Initializers ¶
import org.cdk8s.plus36.Ingress;
Ingress.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .className(java.lang.String)
// .defaultBackend(IngressBackend)
// .rules(java.util.List<IngressRule>)
// .tls(java.util.List<IngressTls>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
className |
java.lang.String |
Class Name for this ingress. |
defaultBackend |
IngressBackend |
The default backend services requests that do not match any rule. |
rules |
java.util.List<IngressRule> |
Routing rules for this ingress. |
tls |
java.util.List<IngressTls> |
TLS settings for this ingress. |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
classNameOptional ¶
- Type: java.lang.String
Class Name for this ingress.
This field is a reference to an IngressClass resource that contains additional Ingress configuration, including the name of the Ingress controller.
defaultBackendOptional ¶
- Type: IngressBackend
The default backend services requests that do not match any rule.
Using this option or the addDefaultBackend() method is equivalent to
adding a rule with both path and host undefined.
rulesOptional ¶
- Type: java.util.List<IngressRule>
Routing rules for this ingress.
Each rule must define an IngressBackend that will receive the requests
that match this rule. If both host and path are not specifiec, this
backend will be used as the default backend of the ingress.
You can also add rules later using addRule(), addHostRule(),
addDefaultBackend() and addHostDefaultBackend().
tlsOptional ¶
- Type: java.util.List<IngressTls>
TLS settings for this ingress.
Using this option tells the ingress controller to expose a TLS endpoint. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addDefaultBackend |
Defines the default backend for this ingress. |
addHostDefaultBackend |
Specify a default backend for a specific host name. |
addHostRule |
Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the Host header matches this value). |
addRule |
Adds an ingress rule applied to requests sent to a specific HTTP path. |
addRules |
Adds rules to this ingress. |
addTls |
No description. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addDefaultBackend ¶
public void addDefaultBackend(IngressBackend backend)
Defines the default backend for this ingress.
A default backend capable of servicing requests that don’t match any rule.
backendRequired ¶
- Type: IngressBackend
The backend to use for requests that do not match any rule.
addHostDefaultBackend ¶
public void addHostDefaultBackend(java.lang.String host, IngressBackend backend)
Specify a default backend for a specific host name.
This backend will be used as a catch-all for requests
targeted to this host name (the Host header matches this value).
hostRequired ¶
- Type: java.lang.String
The host name to match.
backendRequired ¶
- Type: IngressBackend
The backend to route to.
addHostRule ¶
public void addHostRule(java.lang.String host, java.lang.String path, IngressBackend backend)
public void addHostRule(java.lang.String host, java.lang.String path, IngressBackend backend, HttpIngressPathType pathType)
Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the Host header matches this value).
hostRequired ¶
- Type: java.lang.String
The host name.
pathRequired ¶
- Type: java.lang.String
The HTTP path.
backendRequired ¶
- Type: IngressBackend
The backend to route requests to.
pathTypeOptional ¶
- Type: HttpIngressPathType
How the path is matched against request paths.
addRule ¶
public void addRule(java.lang.String path, IngressBackend backend)
public void addRule(java.lang.String path, IngressBackend backend, HttpIngressPathType pathType)
Adds an ingress rule applied to requests sent to a specific HTTP path.
pathRequired ¶
- Type: java.lang.String
The HTTP path.
backendRequired ¶
- Type: IngressBackend
The backend to route requests to.
pathTypeOptional ¶
- Type: HttpIngressPathType
How the path is matched against request paths.
addRules ¶
public void addRules(IngressRule... rules)
Adds rules to this ingress.
rulesRequired ¶
- Type: IngressRule…
The rules to add.
addTls ¶
public void addTls(java.util.List<IngressTls> tls)
tlsRequired ¶
- Type: java.util.List<IngressTls>
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.Ingress;
Ingress.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
Job ¶
A Job creates one or more Pods and ensures that a specified number of them successfully terminate.
As pods successfully complete, the Job tracks the successful completions. When a specified number of successful completions is reached, the task (ie, Job) is complete. Deleting a Job will clean up the Pods it created. A simple case is to create one Job object in order to reliably run one Pod to completion. The Job object will start a new Pod if the first Pod fails or is deleted (for example due to a node hardware failure or a node reboot). You can also use a Job to run multiple Pods in parallel.
Initializers ¶
import org.cdk8s.plus36.Job;
Job.Builder.create(Construct scope, java.lang.String id)
// .metadata(ApiObjectMetadata)
// .automountServiceAccountToken(java.lang.Boolean)
// .containers(java.util.List<ContainerProps>)
// .dns(PodDnsProps)
// .dockerRegistryAuth(ISecret)
// .enableServiceLinks(java.lang.Boolean)
// .hostAliases(java.util.List<HostAlias>)
// .hostNetwork(java.lang.Boolean)
// .initContainers(java.util.List<ContainerProps>)
// .isolate(java.lang.Boolean)
// .restartPolicy(RestartPolicy)
// .securityContext(PodSecurityContextProps)
// .serviceAccount(IServiceAccount)
// .shareProcessNamespace(java.lang.Boolean)
// .terminationGracePeriod(Duration)
// .volumes(java.util.List<Volume>)
// .podMetadata(ApiObjectMetadata)
// .select(java.lang.Boolean)
// .spread(java.lang.Boolean)
// .activeDeadline(Duration)
// .backoffLimit(java.lang.Number)
// .ttlAfterFinished(Duration)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
No description. |
id |
java.lang.String |
No description. |
metadata |
org.cdk8s.ApiObjectMetadata |
Metadata that all persisted resources must have, which includes all objects users must create. |
automountServiceAccountToken |
java.lang.Boolean |
Indicates whether a service account token should be automatically mounted. |
containers |
java.util.List<ContainerProps> |
List of containers belonging to the pod. |
dns |
PodDnsProps |
DNS settings for the pod. |
dockerRegistryAuth |
ISecret |
A secret containing docker credentials for authenticating to a registry. |
enableServiceLinks |
java.lang.Boolean |
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. |
hostAliases |
java.util.List<HostAlias> |
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file. |
hostNetwork |
java.lang.Boolean |
Host network for the pod. |
initContainers |
java.util.List<ContainerProps> |
List of initialization containers belonging to the pod. |
isolate |
java.lang.Boolean |
Isolates the pod. |
restartPolicy |
RestartPolicy |
Restart policy for all containers within the pod. |
securityContext |
PodSecurityContextProps |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccount |
IServiceAccount |
A service account provides an identity for processes that run in a Pod. |
shareProcessNamespace |
java.lang.Boolean |
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod. |
terminationGracePeriod |
org.cdk8s.Duration |
Grace period until the pod is terminated. |
volumes |
java.util.List<Volume> |
List of volumes that can be mounted by containers belonging to the pod. |
podMetadata |
org.cdk8s.ApiObjectMetadata |
The pod metadata of this workload. |
select |
java.lang.Boolean |
Automatically allocates a pod label selector for this workload and add it to the pod metadata. |
spread |
java.lang.Boolean |
Automatically spread pods across hostname and zones. |
activeDeadline |
org.cdk8s.Duration |
Specifies the duration the job may be active before the system tries to terminate it. |
backoffLimit |
java.lang.Number |
Specifies the number of retries before marking this job failed. |
ttlAfterFinished |
org.cdk8s.Duration |
Limits the lifetime of a Job that has finished execution (either Complete or Failed). |
scopeRequired ¶
- Type: software.constructs.Construct
idRequired ¶
- Type: java.lang.String
metadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
Metadata that all persisted resources must have, which includes all objects users must create.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
- Default: false
Indicates whether a service account token should be automatically mounted.
containersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No containers. Note that a pod spec must include at least one container.
List of containers belonging to the pod.
Containers cannot currently be added or removed. There must be at least one container in a Pod.
You can add additionnal containers using podSpec.addContainer()
dnsOptional ¶
- Type: PodDnsProps
- Default: policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false
DNS settings for the pod.
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
dockerRegistryAuthOptional ¶
- Type: ISecret
- Default: No auth. Images are assumed to be publicly available.
A secret containing docker credentials for authenticating to a registry.
enableServiceLinksOptional ¶
- Type: java.lang.Boolean
- Default: true
Indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links.
hostAliasesOptional ¶
- Type: java.util.List<HostAlias>
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
hostNetworkOptional ¶
- Type: java.lang.Boolean
- Default: false
Host network for the pod.
initContainersOptional ¶
- Type: java.util.List<ContainerProps>
- Default: No init containers.
List of initialization containers belonging to the pod.
Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.
Init containers cannot currently be added ,removed or updated.
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
isolateOptional ¶
- Type: java.lang.Boolean
- Default: false
Isolates the pod.
This will prevent any ingress or egress connections to / from this pod.
You can however allow explicit connections post instantiation by using the .connections property.
restartPolicyOptional ¶
- Type: RestartPolicy
- Default: RestartPolicy.ALWAYS
Restart policy for all containers within the pod.
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
securityContextOptional ¶
- Type: PodSecurityContextProps
- Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: true
SecurityContext holds pod-level security attributes and common container settings.
serviceAccountOptional ¶
- Type: IServiceAccount
- Default: No service account.
A service account provides an identity for processes that run in a Pod.
When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespaceOptional ¶
- Type: java.lang.Boolean
- Default: false
When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.
https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
terminationGracePeriodOptional ¶
- Type: org.cdk8s.Duration
- Default: Duration.seconds(30)
Grace period until the pod is terminated.
volumesOptional ¶
- Type: java.util.List<Volume>
- Default: No volumes.
List of volumes that can be mounted by containers belonging to the pod.
You can also add volumes later using podSpec.addVolume()
podMetadataOptional ¶
- Type: org.cdk8s.ApiObjectMetadata
The pod metadata of this workload.
selectOptional ¶
- Type: java.lang.Boolean
- Default: true
Automatically allocates a pod label selector for this workload and add it to the pod metadata.
This ensures this workload manages pods created by its pod template.
spreadOptional ¶
- Type: java.lang.Boolean
- Default: false
Automatically spread pods across hostname and zones.
activeDeadlineOptional ¶
- Type: org.cdk8s.Duration
- Default: If unset, then there is no deadline.
Specifies the duration the job may be active before the system tries to terminate it.
backoffLimitOptional ¶
- Type: java.lang.Number
- Default: If not set, system defaults to 6.
Specifies the number of retries before marking this job failed.
ttlAfterFinishedOptional ¶
- Type: org.cdk8s.Duration
- Default: If this field is unset, the Job won’t be automatically deleted.
Limits the lifetime of a Job that has finished execution (either Complete or Failed).
If this field is set, after the Job finishes, it is eligible to
be automatically deleted. When the Job is being deleted, its lifecycle
guarantees (e.g. finalizers) will be honored. If this field is set to zero,
the Job becomes eligible to be deleted immediately after it finishes. This
field is alpha-level and is only honored by servers that enable the
TTLAfterFinished feature.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
asApiResource |
Return the IApiResource this object represents. |
asNonApiResource |
Return the non resource url this object represents. |
addContainer |
No description. |
addHostAlias |
No description. |
addInitContainer |
No description. |
addVolume |
No description. |
attachContainer |
No description. |
toNetworkPolicyPeerConfig |
Return the configuration of this peer. |
toPodSelector |
Convert the peer into a pod selector, if possible. |
toPodSelectorConfig |
Return the configuration of this selector. |
toSubjectConfiguration |
Return the subject configuration. |
select |
Configure selectors for this workload. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
asApiResource ¶
public IApiResource asApiResource()
Return the IApiResource this object represents.
asNonApiResource ¶
public java.lang.String asNonApiResource()
Return the non resource url this object represents.
addContainer ¶
public Container addContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addHostAlias ¶
public void addHostAlias(HostAlias hostAlias)
hostAliasRequired ¶
- Type: HostAlias
addInitContainer ¶
public Container addInitContainer(ContainerProps cont)
contRequired ¶
- Type: ContainerProps
addVolume ¶
public void addVolume(Volume vol)
volRequired ¶
- Type: Volume
attachContainer ¶
public void attachContainer(Container cont)
contRequired ¶
- Type: Container
toNetworkPolicyPeerConfig ¶
public NetworkPolicyPeerConfig toNetworkPolicyPeerConfig()
Return the configuration of this peer.
toPodSelector ¶
public IPodSelector toPodSelector()
Convert the peer into a pod selector, if possible.
toPodSelectorConfig ¶
public PodSelectorConfig toPodSelectorConfig()
Return the configuration of this selector.
toSubjectConfiguration ¶
public SubjectConfiguration toSubjectConfiguration()
Return the subject configuration.
select ¶
public void select(LabelSelector... selectors)
Configure selectors for this workload.
selectorsRequired ¶
- Type: LabelSelector…
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct ¶
import org.cdk8s.plus36.Job;
Job.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. “authorization.k8s.io”). |
apiVersion |
java.lang.String |
The object’s API version (e.g. “authorization.k8s.io/v1”). |
kind |
java.lang.String |
The object kind (e.g. “Deployment”). |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
No description. |
name |
java.lang.String |
The name of this API object. |
permissions |
ResourcePermissions |
No description. |
resourceType |
java.lang.String |
The name of a resource type as it appears in the relevant API endpoint. |
resourceName |
java.lang.String |
The unique, namespace-global, name of an object inside the Kubernetes cluster. |
automountServiceAccountToken |
java.lang.Boolean |
No description. |
containers |
java.util.List<Container> |
No description. |
dns |
PodDns |
No description. |
hostAliases |
java.util.List<HostAlias> |
No description. |
initContainers |
java.util.List<Container> |
No description. |
podMetadata |
org.cdk8s.ApiObjectMetadataDefinition |
The metadata of pods in this workload. |
securityContext |
PodSecurityContext |
No description. |
shareProcessNamespace |
java.lang.Boolean |
No description. |
volumes |
java.util.List<Volume> |
No description. |
dockerRegistryAuth |
ISecret |
No description. |
enableServiceLinks |
java.lang.Boolean |
No description. |
hostNetwork |
java.lang.Boolean |
No description. |
restartPolicy |
RestartPolicy |
No description. |
serviceAccount |
IServiceAccount |
No description. |
terminationGracePeriod |
org.cdk8s.Duration |
No description. |
connections |
PodConnections |
No description. |
matchExpressions |
java.util.List<LabelSelectorRequirement> |
The expression matchers this workload will use in order to select pods. |
matchLabels |
java.util.Map |
The label matchers this workload will use in order to select pods. |
scheduling |
WorkloadScheduling |
No description. |
activeDeadline |
org.cdk8s.Duration |
Duration before job is terminated. |
backoffLimit |
java.lang.Number |
Number of retries before marking failed. |
ttlAfterFinished |
org.cdk8s.Duration |
TTL before the job is deleted after it is finished. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. “authorization.k8s.io”).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. “authorization.k8s.io/v1”).
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind (e.g. “Deployment”).
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of this API object.
permissionsRequired ¶
public ResourcePermissions getPermissions();
- Type: ResourcePermissions
resourceTypeRequired ¶
public java.lang.String getResourceType();
- Type: java.lang.String
The name of a resource type as it appears in the relevant API endpoint.
resourceNameOptional ¶
public java.lang.String getResourceName();
- Type: java.lang.String
The unique, namespace-global, name of an object inside the Kubernetes cluster.
If this is omitted, the ApiResource should represent all objects of the given type.
automountServiceAccountTokenRequired ¶
public java.lang.Boolean getAutomountServiceAccountToken();
- Type: java.lang.Boolean
containersRequired ¶
public java.util.List<Container> getContainers();
- Type: java.util.List<Container>
dnsRequired ¶
public PodDns getDns();
- Type: PodDns
hostAliasesRequired ¶
public java.util.List<HostAlias> getHostAliases();
- Type: java.util.List<HostAlias>
initContainersRequired ¶
public java.util.List<Container> getInitContainers();
- Type: java.util.List<Container>
podMetadataRequired ¶
public ApiObjectMetadataDefinition getPodMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
The metadata of pods in this workload.
securityContextRequired ¶
public PodSecurityContext getSecurityContext();
- Type: PodSecurityContext
shareProcessNamespaceRequired ¶
public java.lang.Boolean getShareProcessNamespace();
- Type: java.lang.Boolean
volumesRequired ¶
public java.util.List<Volume> getVolumes();
- Type: java.util.List<Volume>
dockerRegistryAuthOptional ¶
public ISecret getDockerRegistryAuth();
- Type: ISecret
enableServiceLinksOptional ¶
public java.lang.Boolean getEnableServiceLinks();
- Type: java.lang.Boolean
hostNetworkOptional ¶
public java.lang.Boolean getHostNetwork();
- Type: java.lang.Boolean
restartPolicyOptional ¶
public RestartPolicy getRestartPolicy();
- Type: RestartPolicy
serviceAccountOptional ¶
public IServiceAccount getServiceAccount();
- Type: IServiceAccount
terminationGracePeriodOptional ¶
public Duration getTerminationGracePeriod();
- Type: org.cdk8s.Duration
connectionsRequired ¶
public PodConnections getConnections();
- Type: PodConnections
matchExpressionsRequired ¶
public java.util.List<LabelSelectorRequirement> getMatchExpressions();
- Type: java.util.List<LabelSelectorRequirement>
The expression matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add expression matchers.
matchLabelsRequired ¶
public java.util.Map<java.lang.String, java.lang.String> getMatchLabels();
- Type: java.util.Map
The label matchers this workload will use in order to select pods.
Returns a a copy. Use select() to add label matchers.
schedulingRequired ¶
public WorkloadScheduling getScheduling();
- Type: WorkloadScheduling
activeDeadlineOptional ¶
public Duration getActiveDeadline();
- Type: org.cdk8s.Duration
Duration before job is terminated.
If undefined, there is no deadline.
backoffLimitOptional ¶
public java.lang.Number getBackoffLimit();
- Type: java.lang.Number
Number of retries before marking failed.
ttlAfterFinishedOptional ¶
public Duration getTtlAfterFinished();
- Type: org.cdk8s.Duration
TTL before the job is deleted after it is finished.
KubeApiService ¶
APIService represents a server for a particular GroupVersion.
Name must be “version.group”.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeApiService;
KubeApiService.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ApiServiceSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.ApiServiceSpec |
Spec contains information for locating and communicating with a server. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ApiServiceSpec
Spec contains information for locating and communicating with a server.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeApiService;
KubeApiService.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeApiService;
KubeApiService.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeApiService;
KubeApiService.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeApiService;
KubeApiService.manifest(),KubeApiService.manifest(KubeApiServiceProps props)
Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeApiServiceProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService”.
KubeApiServiceList ¶
APIServiceList is a list of APIService objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeApiServiceList;
KubeApiServiceList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeApiServiceProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of APIService. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of APIService.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeApiServiceList;
KubeApiServiceList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeApiServiceList;
KubeApiServiceList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeApiServiceList;
KubeApiServiceList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeApiServiceList;
KubeApiServiceList.manifest(KubeApiServiceListProps props)
Renders a Kubernetes manifest for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeApiServiceListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList”.
KubeBinding ¶
Binding ties one object to another;
for example, a pod is bound to a node by a scheduler.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeBinding;
KubeBinding.Builder.create(Construct scope, java.lang.String id)
.target(ObjectReference)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
target |
org.cdk8s.plus36.k8s.ObjectReference |
The target object that you want to bind to the standard object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
targetRequired ¶
- Type: org.cdk8s.plus36.k8s.ObjectReference
The target object that you want to bind to the standard object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Binding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeBinding;
KubeBinding.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeBinding;
KubeBinding.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeBinding;
KubeBinding.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeBinding;
KubeBinding.manifest(KubeBindingProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Binding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeBindingProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Binding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Binding”.
KubeCertificateSigningRequest ¶
CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.
Kubelets use this API to obtain:
- client certificates to authenticate to kube-apiserver (with the “kubernetes.io/kube-apiserver-client-kubelet” signerName).
- serving certificates for TLS endpoints kube-apiserver can connect to securely (with the “kubernetes.io/kubelet-serving” signerName).
This API can be used to request client certificates to authenticate to kube-apiserver (with the “kubernetes.io/kube-apiserver-client” signerName), or to obtain certificates from custom non-Kubernetes signers.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequest;
KubeCertificateSigningRequest.Builder.create(Construct scope, java.lang.String id)
.spec(CertificateSigningRequestSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.CertificateSigningRequestSpec |
spec contains the certificate request, and is immutable after creation. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
No description. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.CertificateSigningRequestSpec
spec contains the certificate request, and is immutable after creation.
Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequest”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequest;
KubeCertificateSigningRequest.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequest;
KubeCertificateSigningRequest.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequest;
KubeCertificateSigningRequest.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequest;
KubeCertificateSigningRequest.manifest(KubeCertificateSigningRequestProps props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequest”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCertificateSigningRequestProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequest”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequest”.
KubeCertificateSigningRequestList ¶
CertificateSigningRequestList is a collection of CertificateSigningRequest objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequestList;
KubeCertificateSigningRequestList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCertificateSigningRequestProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a collection of CertificateSigningRequest objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
No description. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a collection of CertificateSigningRequest objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequestList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequestList;
KubeCertificateSigningRequestList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequestList;
KubeCertificateSigningRequestList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequestList;
KubeCertificateSigningRequestList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCertificateSigningRequestList;
KubeCertificateSigningRequestList.manifest(KubeCertificateSigningRequestListProps props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCertificateSigningRequestListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequestList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1.CertificateSigningRequestList”.
KubeClusterRole ¶
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterRole;
KubeClusterRole.Builder.create(Construct scope, java.lang.String id)
// .aggregationRule(AggregationRule)
// .metadata(ObjectMeta)
// .rules(java.util.List<PolicyRule>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
aggregationRule |
org.cdk8s.plus36.k8s.AggregationRule |
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
rules |
java.util.List |
Rules holds all the PolicyRules for this ClusterRole. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
aggregationRuleOptional ¶
- Type: org.cdk8s.plus36.k8s.AggregationRule
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole.
If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
rulesOptional ¶
- Type: java.util.List
Rules holds all the PolicyRules for this ClusterRole.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRole”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterRole;
KubeClusterRole.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterRole;
KubeClusterRole.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterRole;
KubeClusterRole.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterRole;
KubeClusterRole.manifest(),KubeClusterRole.manifest(KubeClusterRoleProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRole”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterRoleProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRole”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRole”.
KubeClusterRoleBinding ¶
ClusterRoleBinding references a ClusterRole, but not contain it.
It can reference a ClusterRole in the global namespace, and adds who information via Subject.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBinding;
KubeClusterRoleBinding.Builder.create(Construct scope, java.lang.String id)
.roleRef(RoleRef)
// .metadata(ObjectMeta)
// .subjects(java.util.List<Subject>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
roleRef |
org.cdk8s.plus36.k8s.RoleRef |
RoleRef can only reference a ClusterRole in the global namespace. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
subjects |
java.util.List |
Subjects holds references to the objects the role applies to. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
roleRefRequired ¶
- Type: org.cdk8s.plus36.k8s.RoleRef
RoleRef can only reference a ClusterRole in the global namespace.
If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
subjectsOptional ¶
- Type: java.util.List
Subjects holds references to the objects the role applies to.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBinding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBinding;
KubeClusterRoleBinding.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBinding;
KubeClusterRoleBinding.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBinding;
KubeClusterRoleBinding.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBinding;
KubeClusterRoleBinding.manifest(KubeClusterRoleBindingProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBinding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterRoleBindingProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBinding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBinding”.
KubeClusterRoleBindingList ¶
ClusterRoleBindingList is a collection of ClusterRoleBindings.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBindingList;
KubeClusterRoleBindingList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeClusterRoleBindingProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of ClusterRoleBindings. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of ClusterRoleBindings.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBindingList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBindingList;
KubeClusterRoleBindingList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBindingList;
KubeClusterRoleBindingList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBindingList;
KubeClusterRoleBindingList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleBindingList;
KubeClusterRoleBindingList.manifest(KubeClusterRoleBindingListProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterRoleBindingListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBindingList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleBindingList”.
KubeClusterRoleList ¶
ClusterRoleList is a collection of ClusterRoles.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleList;
KubeClusterRoleList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeClusterRoleProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of ClusterRoles. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of ClusterRoles.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleList;
KubeClusterRoleList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleList;
KubeClusterRoleList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleList;
KubeClusterRoleList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterRoleList;
KubeClusterRoleList.manifest(KubeClusterRoleListProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.ClusterRoleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterRoleListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.ClusterRoleList”.
KubeClusterTrustBundleListV1Alpha1 ¶
ClusterTrustBundleList is a collection of ClusterTrustBundle objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1;
KubeClusterTrustBundleListV1Alpha1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeClusterTrustBundleV1Alpha1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a collection of ClusterTrustBundle objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata contains the list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a collection of ClusterTrustBundle objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata contains the list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1;
KubeClusterTrustBundleListV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1;
KubeClusterTrustBundleListV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1;
KubeClusterTrustBundleListV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1;
KubeClusterTrustBundleListV1Alpha1.manifest(KubeClusterTrustBundleListV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundleList”.
KubeClusterTrustBundleListV1Beta1 ¶
ClusterTrustBundleList is a collection of ClusterTrustBundle objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1;
KubeClusterTrustBundleListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeClusterTrustBundleV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a collection of ClusterTrustBundle objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata contains the list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a collection of ClusterTrustBundle objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata contains the list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1;
KubeClusterTrustBundleListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1;
KubeClusterTrustBundleListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1;
KubeClusterTrustBundleListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1;
KubeClusterTrustBundleListV1Beta1.manifest(KubeClusterTrustBundleListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterTrustBundleListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundleList”.
KubeClusterTrustBundleV1Alpha1 ¶
ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).
ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.
It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1;
KubeClusterTrustBundleV1Alpha1.Builder.create(Construct scope, java.lang.String id)
.spec(ClusterTrustBundleSpecV1Alpha1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ClusterTrustBundleSpecV1Alpha1 |
spec contains the signer (if any) and trust anchors. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata contains the object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ClusterTrustBundleSpecV1Alpha1
spec contains the signer (if any) and trust anchors.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata contains the object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1;
KubeClusterTrustBundleV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1;
KubeClusterTrustBundleV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1;
KubeClusterTrustBundleV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1;
KubeClusterTrustBundleV1Alpha1.manifest(KubeClusterTrustBundleV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1alpha1.ClusterTrustBundle”.
KubeClusterTrustBundleV1Beta1 ¶
ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).
ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.
It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1;
KubeClusterTrustBundleV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(ClusterTrustBundleSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ClusterTrustBundleSpecV1Beta1 |
spec contains the signer (if any) and trust anchors. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata contains the object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ClusterTrustBundleSpecV1Beta1
spec contains the signer (if any) and trust anchors.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata contains the object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1;
KubeClusterTrustBundleV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1;
KubeClusterTrustBundleV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1;
KubeClusterTrustBundleV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1;
KubeClusterTrustBundleV1Beta1.manifest(KubeClusterTrustBundleV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeClusterTrustBundleV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.ClusterTrustBundle”.
KubeComponentStatus ¶
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
Deprecated: This API is deprecated in v1.19+
Initializers ¶
import org.cdk8s.plus36.k8s.KubeComponentStatus;
KubeComponentStatus.Builder.create(Construct scope, java.lang.String id)
// .conditions(java.util.List<ComponentCondition>)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
conditions |
java.util.List |
List of component conditions observed. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
conditionsOptional ¶
- Type: java.util.List
List of component conditions observed.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatus”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeComponentStatus;
KubeComponentStatus.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeComponentStatus;
KubeComponentStatus.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeComponentStatus;
KubeComponentStatus.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeComponentStatus;
KubeComponentStatus.manifest(),KubeComponentStatus.manifest(KubeComponentStatusProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatus”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeComponentStatusProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatus”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatus”.
KubeComponentStatusList ¶
Status of all the conditions for the component as a list of ComponentStatus objects.
Deprecated: This API is deprecated in v1.19+
Initializers ¶
import org.cdk8s.plus36.k8s.KubeComponentStatusList;
KubeComponentStatusList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeComponentStatusProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ComponentStatus objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ComponentStatus objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatusList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeComponentStatusList;
KubeComponentStatusList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeComponentStatusList;
KubeComponentStatusList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeComponentStatusList;
KubeComponentStatusList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeComponentStatusList;
KubeComponentStatusList.manifest(KubeComponentStatusListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ComponentStatusList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeComponentStatusListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatusList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ComponentStatusList”.
KubeConfigMap ¶
ConfigMap holds configuration data for pods to consume.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeConfigMap;
KubeConfigMap.Builder.create(Construct scope, java.lang.String id)
// .binaryData(java.util.Map<java.lang.String, java.lang.String>)
// .data(java.util.Map<java.lang.String, java.lang.String>)
// .immutable(java.lang.Boolean)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
binaryData |
java.util.Map |
BinaryData contains the binary data. |
data |
java.util.Map |
Data contains the configuration data. |
immutable |
java.lang.Boolean |
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
binaryDataOptional ¶
- Type: java.util.Map
BinaryData contains the binary data.
Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
dataOptional ¶
- Type: java.util.Map
Data contains the configuration data.
Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
immutableOptional ¶
- Type: java.lang.Boolean
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified).
If not set to true, the field can be modified at any time. Defaulted to nil.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMap”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeConfigMap;
KubeConfigMap.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeConfigMap;
KubeConfigMap.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeConfigMap;
KubeConfigMap.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeConfigMap;
KubeConfigMap.manifest(),KubeConfigMap.manifest(KubeConfigMapProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMap”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeConfigMapProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMap”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMap”.
KubeConfigMapList ¶
ConfigMapList is a resource containing a list of ConfigMap objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeConfigMapList;
KubeConfigMapList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeConfigMapProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of ConfigMaps. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of ConfigMaps.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMapList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeConfigMapList;
KubeConfigMapList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeConfigMapList;
KubeConfigMapList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeConfigMapList;
KubeConfigMapList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeConfigMapList;
KubeConfigMapList.manifest(KubeConfigMapListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ConfigMapList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeConfigMapListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMapList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ConfigMapList”.
KubeControllerRevision ¶
ControllerRevision implements an immutable snapshot of state data.
Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeControllerRevision;
KubeControllerRevision.Builder.create(Construct scope, java.lang.String id)
.revision(java.lang.Number)
// .data(java.lang.Object)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
revision |
java.lang.Number |
Revision indicates the revision of the state represented by Data. |
data |
java.lang.Object |
Data is the serialized representation of the state. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
revisionRequired ¶
- Type: java.lang.Number
Revision indicates the revision of the state represented by Data.
dataOptional ¶
- Type: java.lang.Object
Data is the serialized representation of the state.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevision”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeControllerRevision;
KubeControllerRevision.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeControllerRevision;
KubeControllerRevision.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeControllerRevision;
KubeControllerRevision.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeControllerRevision;
KubeControllerRevision.manifest(KubeControllerRevisionProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevision”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeControllerRevisionProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevision”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevision”.
KubeControllerRevisionList ¶
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeControllerRevisionList;
KubeControllerRevisionList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeControllerRevisionProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of ControllerRevisions. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of ControllerRevisions.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevisionList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeControllerRevisionList;
KubeControllerRevisionList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeControllerRevisionList;
KubeControllerRevisionList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeControllerRevisionList;
KubeControllerRevisionList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeControllerRevisionList;
KubeControllerRevisionList.manifest(KubeControllerRevisionListProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ControllerRevisionList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeControllerRevisionListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevisionList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ControllerRevisionList”.
KubeCronJob ¶
CronJob represents the configuration of a single cron job.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCronJob;
KubeCronJob.Builder.create(Construct scope, java.lang.String id)
.spec(CronJobSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.CronJobSpec |
Specification of the desired behavior of a cron job, including the schedule. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.CronJobSpec
Specification of the desired behavior of a cron job, including the schedule.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJob”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCronJob;
KubeCronJob.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCronJob;
KubeCronJob.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCronJob;
KubeCronJob.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCronJob;
KubeCronJob.manifest(KubeCronJobProps props)
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJob”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCronJobProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJob”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJob”.
KubeCronJobList ¶
CronJobList is a collection of cron jobs.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCronJobList;
KubeCronJobList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCronJobProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of CronJobs. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of CronJobs.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJobList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCronJobList;
KubeCronJobList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCronJobList;
KubeCronJobList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCronJobList;
KubeCronJobList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCronJobList;
KubeCronJobList.manifest(KubeCronJobListProps props)
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.CronJobList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCronJobListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJobList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.batch.v1.CronJobList”.
KubeCsiDriver ¶
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster.
Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiDriver;
KubeCsiDriver.Builder.create(Construct scope, java.lang.String id)
.spec(CsiDriverSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.CsiDriverSpec |
spec represents the specification of the CSI Driver. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.CsiDriverSpec
spec represents the specification of the CSI Driver.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriver”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiDriver;
KubeCsiDriver.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiDriver;
KubeCsiDriver.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiDriver;
KubeCsiDriver.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiDriver;
KubeCsiDriver.manifest(KubeCsiDriverProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriver”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiDriverProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriver”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriver”.
KubeCsiDriverList ¶
CSIDriverList is a collection of CSIDriver objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiDriverList;
KubeCsiDriverList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCsiDriverProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of CSIDriver. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of CSIDriver.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriverList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiDriverList;
KubeCsiDriverList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiDriverList;
KubeCsiDriverList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiDriverList;
KubeCsiDriverList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiDriverList;
KubeCsiDriverList.manifest(KubeCsiDriverListProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIDriverList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiDriverListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriverList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIDriverList”.
KubeCsiNode ¶
CSINode holds information about all CSI drivers installed on a node.
CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn’t create this object. CSINode has an OwnerReference that points to the corresponding node object.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiNode;
KubeCsiNode.Builder.create(Construct scope, java.lang.String id)
.spec(CsiNodeSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.CsiNodeSpec |
spec is the specification of CSINode. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.CsiNodeSpec
spec is the specification of CSINode.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
metadata.name must be the Kubernetes node name.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINode”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiNode;
KubeCsiNode.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiNode;
KubeCsiNode.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiNode;
KubeCsiNode.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiNode;
KubeCsiNode.manifest(KubeCsiNodeProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINode”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiNodeProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINode”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINode”.
KubeCsiNodeList ¶
CSINodeList is a collection of CSINode objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiNodeList;
KubeCsiNodeList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCsiNodeProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of CSINode. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of CSINode.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINodeList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiNodeList;
KubeCsiNodeList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiNodeList;
KubeCsiNodeList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiNodeList;
KubeCsiNodeList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiNodeList;
KubeCsiNodeList.manifest(KubeCsiNodeListProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSINodeList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiNodeListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINodeList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSINodeList”.
KubeCsiStorageCapacity ¶
CSIStorageCapacity stores the result of one CSI GetCapacity call.
For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
For example this can express things like: - StorageClass “standard” has “1234 GiB” available in “topology.kubernetes.io/zone=us-east1” - StorageClass “localssd” has “10 GiB” available in “kubernetes.io/hostname=knode-abc123”
The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero
The producer of these objects can decide which approach is more suitable.
They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacity;
KubeCsiStorageCapacity.Builder.create(Construct scope, java.lang.String id)
.storageClassName(java.lang.String)
// .capacity(Quantity)
// .maximumVolumeSize(Quantity)
// .metadata(ObjectMeta)
// .nodeTopology(LabelSelector)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
storageClassName |
java.lang.String |
storageClassName represents the name of the StorageClass that the reported capacity applies to. |
capacity |
org.cdk8s.plus36.k8s.Quantity |
capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. |
maximumVolumeSize |
org.cdk8s.plus36.k8s.Quantity |
maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
nodeTopology |
org.cdk8s.plus36.k8s.LabelSelector |
nodeTopology defines which nodes have access to the storage for which capacity was reported. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
storageClassNameRequired ¶
- Type: java.lang.String
storageClassName represents the name of the StorageClass that the reported capacity applies to.
It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
capacityOptional ¶
- Type: org.cdk8s.plus36.k8s.Quantity
capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.
maximumVolumeSizeOptional ¶
- Type: org.cdk8s.plus36.k8s.Quantity
maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-
Objects are namespaced.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
nodeTopologyOptional ¶
- Type: org.cdk8s.plus36.k8s.LabelSelector
nodeTopology defines which nodes have access to the storage for which capacity was reported.
If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacity”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacity;
KubeCsiStorageCapacity.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacity;
KubeCsiStorageCapacity.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacity;
KubeCsiStorageCapacity.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacity;
KubeCsiStorageCapacity.manifest(KubeCsiStorageCapacityProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacity”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiStorageCapacityProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacity”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacity”.
KubeCsiStorageCapacityList ¶
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacityList;
KubeCsiStorageCapacityList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCsiStorageCapacityProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of CSIStorageCapacity objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of CSIStorageCapacity objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacityList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacityList;
KubeCsiStorageCapacityList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacityList;
KubeCsiStorageCapacityList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacityList;
KubeCsiStorageCapacityList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCsiStorageCapacityList;
KubeCsiStorageCapacityList.manifest(KubeCsiStorageCapacityListProps props)
Renders a Kubernetes manifest for “io.k8s.api.storage.v1.CSIStorageCapacityList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCsiStorageCapacityListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacityList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.storage.v1.CSIStorageCapacityList”.
KubeCustomResourceDefinition ¶
CustomResourceDefinition represents a resource that should be exposed on the API server.
Its name MUST be in the format <.spec.name>.<.spec.group>.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinition;
KubeCustomResourceDefinition.Builder.create(Construct scope, java.lang.String id)
.spec(CustomResourceDefinitionSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.CustomResourceDefinitionSpec |
spec describes how the user wants the resources to appear. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.CustomResourceDefinitionSpec
spec describes how the user wants the resources to appear.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinition;
KubeCustomResourceDefinition.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinition;
KubeCustomResourceDefinition.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinition;
KubeCustomResourceDefinition.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinition;
KubeCustomResourceDefinition.manifest(KubeCustomResourceDefinitionProps props)
Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition”.
KubeCustomResourceDefinitionList ¶
CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionList;
KubeCustomResourceDefinitionList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeCustomResourceDefinitionProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items list individual CustomResourceDefinition objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items list individual CustomResourceDefinition objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionList;
KubeCustomResourceDefinitionList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionList;
KubeCustomResourceDefinitionList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionList;
KubeCustomResourceDefinitionList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionList;
KubeCustomResourceDefinitionList.manifest(KubeCustomResourceDefinitionListProps props)
Renders a Kubernetes manifest for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeCustomResourceDefinitionListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList”.
KubeDaemonSet ¶
DaemonSet represents the configuration of a daemon set.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDaemonSet;
KubeDaemonSet.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(DaemonSetSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.DaemonSetSpec |
The desired behavior of this daemon set. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.DaemonSetSpec
The desired behavior of this daemon set.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSet”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDaemonSet;
KubeDaemonSet.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDaemonSet;
KubeDaemonSet.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDaemonSet;
KubeDaemonSet.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDaemonSet;
KubeDaemonSet.manifest(),KubeDaemonSet.manifest(KubeDaemonSetProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSet”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeDaemonSetProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSet”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSet”.
KubeDaemonSetList ¶
DaemonSetList is a collection of daemon sets.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDaemonSetList;
KubeDaemonSetList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDaemonSetProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
A list of daemon sets. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
A list of daemon sets.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSetList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDaemonSetList;
KubeDaemonSetList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDaemonSetList;
KubeDaemonSetList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDaemonSetList;
KubeDaemonSetList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDaemonSetList;
KubeDaemonSetList.manifest(KubeDaemonSetListProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DaemonSetList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDaemonSetListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSetList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DaemonSetList”.
KubeDeployment ¶
Deployment enables declarative updates for Pods and ReplicaSets.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeployment;
KubeDeployment.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(DeploymentSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.DeploymentSpec |
Specification of the desired behavior of the Deployment. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.DeploymentSpec
Specification of the desired behavior of the Deployment.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.Deployment”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeployment;
KubeDeployment.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeployment;
KubeDeployment.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeployment;
KubeDeployment.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeployment;
KubeDeployment.manifest(),KubeDeployment.manifest(KubeDeploymentProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.Deployment”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeDeploymentProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.Deployment”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.Deployment”.
KubeDeploymentList ¶
DeploymentList is a list of Deployments.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeploymentList;
KubeDeploymentList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeploymentProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of Deployments. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of Deployments.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DeploymentList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeploymentList;
KubeDeploymentList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeploymentList;
KubeDeploymentList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeploymentList;
KubeDeploymentList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeploymentList;
KubeDeploymentList.manifest(KubeDeploymentListProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.DeploymentList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeploymentListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DeploymentList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.DeploymentList”.
KubeDeviceClass ¶
DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.
It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClass;
KubeDeviceClass.Builder.create(Construct scope, java.lang.String id)
.spec(DeviceClassSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.DeviceClassSpec |
Spec defines what can be allocated and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.DeviceClassSpec
Spec defines what can be allocated and how to configure it.
This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClass;
KubeDeviceClass.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClass;
KubeDeviceClass.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClass;
KubeDeviceClass.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClass;
KubeDeviceClass.manifest(KubeDeviceClassProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClass”.
KubeDeviceClassList ¶
DeviceClassList is a collection of classes.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassList;
KubeDeviceClassList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeviceClassProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource classes. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource classes.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassList;
KubeDeviceClassList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassList;
KubeDeviceClassList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassList;
KubeDeviceClassList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassList;
KubeDeviceClassList.manifest(KubeDeviceClassListProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.DeviceClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.DeviceClassList”.
KubeDeviceClassListV1Beta1 ¶
DeviceClassList is a collection of classes.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1;
KubeDeviceClassListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeviceClassV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource classes. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource classes.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1;
KubeDeviceClassListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1;
KubeDeviceClassListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1;
KubeDeviceClassListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1;
KubeDeviceClassListV1Beta1.manifest(KubeDeviceClassListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClassList”.
KubeDeviceClassListV1Beta2 ¶
DeviceClassList is a collection of classes.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2;
KubeDeviceClassListV1Beta2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeviceClassV1Beta2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource classes. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource classes.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2;
KubeDeviceClassListV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2;
KubeDeviceClassListV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2;
KubeDeviceClassListV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2;
KubeDeviceClassListV1Beta2.manifest(KubeDeviceClassListV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassListV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClassList”.
KubeDeviceClassV1Beta1 ¶
DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.
It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1;
KubeDeviceClassV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(DeviceClassSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.DeviceClassSpecV1Beta1 |
Spec defines what can be allocated and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.DeviceClassSpecV1Beta1
Spec defines what can be allocated and how to configure it.
This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1;
KubeDeviceClassV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1;
KubeDeviceClassV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1;
KubeDeviceClassV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1;
KubeDeviceClassV1Beta1.manifest(KubeDeviceClassV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.DeviceClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.DeviceClass”.
KubeDeviceClassV1Beta2 ¶
DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.
It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2;
KubeDeviceClassV1Beta2.Builder.create(Construct scope, java.lang.String id)
.spec(DeviceClassSpecV1Beta2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.DeviceClassSpecV1Beta2 |
Spec defines what can be allocated and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.DeviceClassSpecV1Beta2
Spec defines what can be allocated and how to configure it.
This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2;
KubeDeviceClassV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2;
KubeDeviceClassV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2;
KubeDeviceClassV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2;
KubeDeviceClassV1Beta2.manifest(KubeDeviceClassV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceClassV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceClass”.
KubeDeviceTaintRuleListV1Alpha3 ¶
DeviceTaintRuleList is a collection of DeviceTaintRules.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3;
KubeDeviceTaintRuleListV1Alpha3.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeviceTaintRuleV1Alpha3Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of DeviceTaintRules. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of DeviceTaintRules.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3;
KubeDeviceTaintRuleListV1Alpha3.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3;
KubeDeviceTaintRuleListV1Alpha3.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3;
KubeDeviceTaintRuleListV1Alpha3.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3;
KubeDeviceTaintRuleListV1Alpha3.manifest(KubeDeviceTaintRuleListV1Alpha3Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Alpha3Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRuleList”.
KubeDeviceTaintRuleListV1Beta2 ¶
DeviceTaintRuleList is a collection of DeviceTaintRules.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2;
KubeDeviceTaintRuleListV1Beta2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeDeviceTaintRuleV1Beta2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of DeviceTaintRules. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of DeviceTaintRules.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceTaintRuleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2;
KubeDeviceTaintRuleListV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2;
KubeDeviceTaintRuleListV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2;
KubeDeviceTaintRuleListV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2;
KubeDeviceTaintRuleListV1Beta2.manifest(KubeDeviceTaintRuleListV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceTaintRuleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceTaintRuleListV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceTaintRuleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceTaintRuleList”.
KubeDeviceTaintRuleV1Alpha3 ¶
DeviceTaintRule adds one taint to all devices which match the selector.
This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3;
KubeDeviceTaintRuleV1Alpha3.Builder.create(Construct scope, java.lang.String id)
.spec(DeviceTaintRuleSpecV1Alpha3)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.DeviceTaintRuleSpecV1Alpha3 |
Spec specifies the selector and one taint. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.DeviceTaintRuleSpecV1Alpha3
Spec specifies the selector and one taint.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3;
KubeDeviceTaintRuleV1Alpha3.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3;
KubeDeviceTaintRuleV1Alpha3.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3;
KubeDeviceTaintRuleV1Alpha3.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3;
KubeDeviceTaintRuleV1Alpha3.manifest(KubeDeviceTaintRuleV1Alpha3Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Alpha3Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.DeviceTaintRule”.
KubeDeviceTaintRuleV1Beta2 ¶
DeviceTaintRule adds one taint to all devices which match the selector.
This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2;
KubeDeviceTaintRuleV1Beta2.Builder.create(Construct scope, java.lang.String id)
.spec(DeviceTaintRuleSpecV1Beta2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.DeviceTaintRuleSpecV1Beta2 |
Spec specifies the selector and one taint. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.DeviceTaintRuleSpecV1Beta2
Spec specifies the selector and one taint.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceTaintRule”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2;
KubeDeviceTaintRuleV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2;
KubeDeviceTaintRuleV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2;
KubeDeviceTaintRuleV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2;
KubeDeviceTaintRuleV1Beta2.manifest(KubeDeviceTaintRuleV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.DeviceTaintRule”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeDeviceTaintRuleV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceTaintRule”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.DeviceTaintRule”.
KubeEndpoints ¶
Endpoints is a collection of endpoints that implement the actual service. Example:.
Name: “mysvc”, Subsets: [ { Addresses: [{“ip”: “10.10.1.1”}, {“ip”: “10.10.2.2”}], Ports: [{“name”: “a”, “port”: 8675}, {“name”: “b”, “port”: 309}] }, { Addresses: [{“ip”: “10.10.3.3”}], Ports: [{“name”: “a”, “port”: 93}, {“name”: “b”, “port”: 76}] }, ]
Endpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints.
Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEndpoints;
KubeEndpoints.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .subsets(java.util.List<EndpointSubset>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
subsets |
java.util.List |
The set of all endpoints is the union of all subsets. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
subsetsOptional ¶
- Type: java.util.List
The set of all endpoints is the union of all subsets.
Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Endpoints”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEndpoints;
KubeEndpoints.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEndpoints;
KubeEndpoints.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEndpoints;
KubeEndpoints.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEndpoints;
KubeEndpoints.manifest(),KubeEndpoints.manifest(KubeEndpointsProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Endpoints”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeEndpointsProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Endpoints”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Endpoints”.
KubeEndpointSlice ¶
EndpointSlice represents a set of service endpoints.
Most EndpointSlices are created by the EndpointSlice controller to represent the Pods selected by Service objects. For a given service there may be multiple EndpointSlice objects which must be joined to produce the full set of endpoints; you can find all of the slices for a given service by listing EndpointSlices in the service’s namespace whose kubernetes.io/service-name label contains the service’s name.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEndpointSlice;
KubeEndpointSlice.Builder.create(Construct scope, java.lang.String id)
.addressType(java.lang.String)
// .endpoints(java.util.List<Endpoint>)
// .metadata(ObjectMeta)
// .ports(java.util.List<EndpointPort>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
addressType |
java.lang.String |
addressType specifies the type of address carried by this EndpointSlice. |
endpoints |
java.util.List |
endpoints is a list of unique endpoints in this slice. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
ports |
java.util.List |
ports specifies the list of network ports exposed by each endpoint in this slice. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
addressTypeRequired ¶
- Type: java.lang.String
addressType specifies the type of address carried by this EndpointSlice.
All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. (Deprecated) The EndpointSlice controller only generates, and kube-proxy only processes, slices of addressType “IPv4” and “IPv6”. No semantics are defined for the “FQDN” type.
endpointsOptional ¶
- Type: java.util.List
endpoints is a list of unique endpoints in this slice.
Each slice may include a maximum of 1000 endpoints.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
portsOptional ¶
- Type: java.util.List
ports specifies the list of network ports exposed by each endpoint in this slice.
Each port must have a unique name. Each slice may include a maximum of 100 ports. Services always have at least 1 port, so EndpointSlices generated by the EndpointSlice controller will likewise always have at least 1 port. EndpointSlices used for other purposes may have an empty ports list.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSlice”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEndpointSlice;
KubeEndpointSlice.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEndpointSlice;
KubeEndpointSlice.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEndpointSlice;
KubeEndpointSlice.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEndpointSlice;
KubeEndpointSlice.manifest(KubeEndpointSliceProps props)
Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSlice”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeEndpointSliceProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSlice”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSlice”.
KubeEndpointSliceList ¶
EndpointSliceList represents a list of endpoint slices.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEndpointSliceList;
KubeEndpointSliceList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeEndpointSliceProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of endpoint slices. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of endpoint slices.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSliceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEndpointSliceList;
KubeEndpointSliceList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEndpointSliceList;
KubeEndpointSliceList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEndpointSliceList;
KubeEndpointSliceList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEndpointSliceList;
KubeEndpointSliceList.manifest(KubeEndpointSliceListProps props)
Renders a Kubernetes manifest for “io.k8s.api.discovery.v1.EndpointSliceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeEndpointSliceListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSliceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.discovery.v1.EndpointSliceList”.
KubeEndpointsList ¶
EndpointsList is a list of endpoints.
Deprecated: This API is deprecated in v1.33+.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEndpointsList;
KubeEndpointsList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeEndpointsProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of endpoints. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of endpoints.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.EndpointsList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEndpointsList;
KubeEndpointsList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEndpointsList;
KubeEndpointsList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEndpointsList;
KubeEndpointsList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEndpointsList;
KubeEndpointsList.manifest(KubeEndpointsListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.EndpointsList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeEndpointsListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.EndpointsList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.EndpointsList”.
KubeEvent ¶
Event is a report of an event somewhere in the cluster.
It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEvent;
KubeEvent.Builder.create(Construct scope, java.lang.String id)
.eventTime(java.time.Instant)
// .action(java.lang.String)
// .deprecatedCount(java.lang.Number)
// .deprecatedFirstTimestamp(java.time.Instant)
// .deprecatedLastTimestamp(java.time.Instant)
// .deprecatedSource(EventSource)
// .metadata(ObjectMeta)
// .note(java.lang.String)
// .reason(java.lang.String)
// .regarding(ObjectReference)
// .related(ObjectReference)
// .reportingController(java.lang.String)
// .reportingInstance(java.lang.String)
// .series(EventSeries)
// .type(java.lang.String)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
eventTime |
java.time.Instant |
eventTime is the time when this Event was first observed. |
action |
java.lang.String |
action is what action was taken/failed regarding to the regarding object. |
deprecatedCount |
java.lang.Number |
deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedFirstTimestamp |
java.time.Instant |
deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedLastTimestamp |
java.time.Instant |
deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedSource |
org.cdk8s.plus36.k8s.EventSource |
deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
note |
java.lang.String |
note is a human-readable description of the status of this operation. |
reason |
java.lang.String |
reason is why the action was taken. |
regarding |
org.cdk8s.plus36.k8s.ObjectReference |
regarding contains the object this Event is about. |
related |
org.cdk8s.plus36.k8s.ObjectReference |
related is the optional secondary object for more complex actions. |
reportingController |
java.lang.String |
reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events. |
reportingInstance |
java.lang.String |
reportingInstance is the ID of the controller instance, e.g. kubelet-xyzf. This field cannot be empty for new Events and it can have at most 128 characters. |
series |
org.cdk8s.plus36.k8s.EventSeries |
series is data about the Event series this event represents or nil if it’s a singleton Event. |
type |
java.lang.String |
type is the type of this event (Normal, Warning), new types could be added in the future. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
eventTimeRequired ¶
- Type: java.time.Instant
eventTime is the time when this Event was first observed.
It is required.
actionOptional ¶
- Type: java.lang.String
action is what action was taken/failed regarding to the regarding object.
It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.
deprecatedCountOptional ¶
- Type: java.lang.Number
deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
deprecatedFirstTimestampOptional ¶
- Type: java.time.Instant
deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
deprecatedLastTimestampOptional ¶
- Type: java.time.Instant
deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
deprecatedSourceOptional ¶
- Type: org.cdk8s.plus36.k8s.EventSource
deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
noteOptional ¶
- Type: java.lang.String
note is a human-readable description of the status of this operation.
Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
reasonOptional ¶
- Type: java.lang.String
reason is why the action was taken.
It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.
regardingOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectReference
regarding contains the object this Event is about.
In most cases it’s an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
relatedOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectReference
related is the optional secondary object for more complex actions.
E.g. when regarding object triggers a creation or deletion of related object.
reportingControllerOptional ¶
- Type: java.lang.String
reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events.
reportingInstanceOptional ¶
- Type: java.lang.String
reportingInstance is the ID of the controller instance, e.g. kubelet-xyzf. This field cannot be empty for new Events and it can have at most 128 characters.
seriesOptional ¶
- Type: org.cdk8s.plus36.k8s.EventSeries
series is data about the Event series this event represents or nil if it’s a singleton Event.
typeOptional ¶
- Type: java.lang.String
type is the type of this event (Normal, Warning), new types could be added in the future.
It is machine-readable. This field cannot be empty for new Events.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.events.v1.Event”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEvent;
KubeEvent.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEvent;
KubeEvent.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEvent;
KubeEvent.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEvent;
KubeEvent.manifest(KubeEventProps props)
Renders a Kubernetes manifest for “io.k8s.api.events.v1.Event”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeEventProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.events.v1.Event”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.events.v1.Event”.
KubeEventList ¶
EventList is a list of Event objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEventList;
KubeEventList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeEventProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.events.v1.EventList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEventList;
KubeEventList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEventList;
KubeEventList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEventList;
KubeEventList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEventList;
KubeEventList.manifest(KubeEventListProps props)
Renders a Kubernetes manifest for “io.k8s.api.events.v1.EventList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeEventListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.events.v1.EventList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.events.v1.EventList”.
KubeEviction ¶
Eviction evicts a pod from its node subject to certain policies and safety constraints.
This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/
Initializers ¶
import org.cdk8s.plus36.k8s.KubeEviction;
KubeEviction.Builder.create(Construct scope, java.lang.String id)
// .deleteOptions(DeleteOptions)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
deleteOptions |
org.cdk8s.plus36.k8s.DeleteOptions |
DeleteOptions may be provided. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
ObjectMeta describes the pod that is being evicted. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
deleteOptionsOptional ¶
- Type: org.cdk8s.plus36.k8s.DeleteOptions
DeleteOptions may be provided.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
ObjectMeta describes the pod that is being evicted.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.Eviction”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeEviction;
KubeEviction.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeEviction;
KubeEviction.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeEviction;
KubeEviction.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeEviction;
KubeEviction.manifest(),KubeEviction.manifest(KubeEvictionProps props)
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.Eviction”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeEvictionProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.policy.v1.Eviction”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.policy.v1.Eviction”.
KubeFlowSchema ¶
FlowSchema defines the schema of a group of flows.
Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a “flow distinguisher”.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeFlowSchema;
KubeFlowSchema.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(FlowSchemaSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.FlowSchemaSpec |
spec is the specification of the desired behavior of a FlowSchema. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.FlowSchemaSpec
spec is the specification of the desired behavior of a FlowSchema.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchema”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeFlowSchema;
KubeFlowSchema.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeFlowSchema;
KubeFlowSchema.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeFlowSchema;
KubeFlowSchema.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeFlowSchema;
KubeFlowSchema.manifest(),KubeFlowSchema.manifest(KubeFlowSchemaProps props)
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchema”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeFlowSchemaProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchema”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchema”.
KubeFlowSchemaList ¶
FlowSchemaList is a list of FlowSchema objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeFlowSchemaList;
KubeFlowSchemaList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeFlowSchemaProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of FlowSchemas. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of FlowSchemas.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchemaList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeFlowSchemaList;
KubeFlowSchemaList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeFlowSchemaList;
KubeFlowSchemaList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeFlowSchemaList;
KubeFlowSchemaList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeFlowSchemaList;
KubeFlowSchemaList.manifest(KubeFlowSchemaListProps props)
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeFlowSchemaListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchemaList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.FlowSchemaList”.
KubeHorizontalPodAutoscaler ¶
configuration of a horizontal pod autoscaler.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscaler;
KubeHorizontalPodAutoscaler.Builder.create(Construct scope, java.lang.String id)
.spec(HorizontalPodAutoscalerSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.HorizontalPodAutoscalerSpec |
spec defines the behaviour of autoscaler. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.HorizontalPodAutoscalerSpec
spec defines the behaviour of autoscaler.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscaler;
KubeHorizontalPodAutoscaler.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscaler;
KubeHorizontalPodAutoscaler.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscaler;
KubeHorizontalPodAutoscaler.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscaler;
KubeHorizontalPodAutoscaler.manifest(KubeHorizontalPodAutoscalerProps props)
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler”.
KubeHorizontalPodAutoscalerList ¶
list of horizontal pod autoscaler objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerList;
KubeHorizontalPodAutoscalerList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeHorizontalPodAutoscalerProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of horizontal pod autoscaler objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of horizontal pod autoscaler objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerList;
KubeHorizontalPodAutoscalerList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerList;
KubeHorizontalPodAutoscalerList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerList;
KubeHorizontalPodAutoscalerList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerList;
KubeHorizontalPodAutoscalerList.manifest(KubeHorizontalPodAutoscalerListProps props)
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList”.
KubeHorizontalPodAutoscalerListV2 ¶
HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2;
KubeHorizontalPodAutoscalerListV2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeHorizontalPodAutoscalerV2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of horizontal pod autoscaler objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of horizontal pod autoscaler objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2;
KubeHorizontalPodAutoscalerListV2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2;
KubeHorizontalPodAutoscalerListV2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2;
KubeHorizontalPodAutoscalerListV2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2;
KubeHorizontalPodAutoscalerListV2.manifest(KubeHorizontalPodAutoscalerListV2Props props)
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerListV2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList”.
KubeHorizontalPodAutoscalerV2 ¶
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2;
KubeHorizontalPodAutoscalerV2.Builder.create(Construct scope, java.lang.String id)
.spec(HorizontalPodAutoscalerSpecV2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.HorizontalPodAutoscalerSpecV2 |
spec is the specification for the behaviour of the autoscaler. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.HorizontalPodAutoscalerSpecV2
spec is the specification for the behaviour of the autoscaler.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2;
KubeHorizontalPodAutoscalerV2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2;
KubeHorizontalPodAutoscalerV2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2;
KubeHorizontalPodAutoscalerV2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2;
KubeHorizontalPodAutoscalerV2.manifest(KubeHorizontalPodAutoscalerV2Props props)
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeHorizontalPodAutoscalerV2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler”.
KubeIngress ¶
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.
An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIngress;
KubeIngress.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(IngressSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.IngressSpec |
spec is the desired state of the Ingress. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.IngressSpec
spec is the desired state of the Ingress.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.Ingress”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIngress;
KubeIngress.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIngress;
KubeIngress.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIngress;
KubeIngress.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIngress;
KubeIngress.manifest(),KubeIngress.manifest(KubeIngressProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.Ingress”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeIngressProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.Ingress”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.Ingress”.
KubeIngressClass ¶
IngressClass represents the class of the Ingress, referenced by the Ingress Spec.
The ingressclass.kubernetes.io/is-default-class annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIngressClass;
KubeIngressClass.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(IngressClassSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.IngressClassSpec |
spec is the desired state of the IngressClass. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.IngressClassSpec
spec is the desired state of the IngressClass.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIngressClass;
KubeIngressClass.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIngressClass;
KubeIngressClass.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIngressClass;
KubeIngressClass.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIngressClass;
KubeIngressClass.manifest(),KubeIngressClass.manifest(KubeIngressClassProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeIngressClassProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClass”.
KubeIngressClassList ¶
IngressClassList is a collection of IngressClasses.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIngressClassList;
KubeIngressClassList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeIngressClassProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of IngressClasses. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of IngressClasses.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIngressClassList;
KubeIngressClassList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIngressClassList;
KubeIngressClassList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIngressClassList;
KubeIngressClassList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIngressClassList;
KubeIngressClassList.manifest(KubeIngressClassListProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIngressClassListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressClassList”.
KubeIngressList ¶
IngressList is a collection of Ingress.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIngressList;
KubeIngressList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeIngressProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of Ingress. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of Ingress.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIngressList;
KubeIngressList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIngressList;
KubeIngressList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIngressList;
KubeIngressList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIngressList;
KubeIngressList.manifest(KubeIngressListProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IngressList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIngressListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IngressList”.
KubeIpAddress ¶
IPAddress represents a single IP of a single IP Family.
The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIpAddress;
KubeIpAddress.Builder.create(Construct scope, java.lang.String id)
.spec(IpAddressSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.IpAddressSpec |
spec is the desired state of the IPAddress. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.IpAddressSpec
spec is the desired state of the IPAddress.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddress”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIpAddress;
KubeIpAddress.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIpAddress;
KubeIpAddress.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIpAddress;
KubeIpAddress.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIpAddress;
KubeIpAddress.manifest(KubeIpAddressProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddress”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIpAddressProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddress”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddress”.
KubeIpAddressList ¶
IPAddressList contains a list of IPAddress.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIpAddressList;
KubeIpAddressList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeIpAddressProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of IPAddresses. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of IPAddresses.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddressList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIpAddressList;
KubeIpAddressList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIpAddressList;
KubeIpAddressList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIpAddressList;
KubeIpAddressList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIpAddressList;
KubeIpAddressList.manifest(KubeIpAddressListProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.IPAddressList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIpAddressListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddressList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.IPAddressList”.
KubeIpAddressListV1Beta1 ¶
IPAddressList contains a list of IPAddress.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1;
KubeIpAddressListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeIpAddressV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of IPAddresses. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of IPAddresses.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddressList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1;
KubeIpAddressListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1;
KubeIpAddressListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1;
KubeIpAddressListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1;
KubeIpAddressListV1Beta1.manifest(KubeIpAddressListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddressList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIpAddressListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddressList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddressList”.
KubeIpAddressV1Beta1 ¶
IPAddress represents a single IP of a single IP Family.
The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
Initializers ¶
import org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1;
KubeIpAddressV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(IpAddressSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.IpAddressSpecV1Beta1 |
spec is the desired state of the IPAddress. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.IpAddressSpecV1Beta1
spec is the desired state of the IPAddress.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddress”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1;
KubeIpAddressV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1;
KubeIpAddressV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1;
KubeIpAddressV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1;
KubeIpAddressV1Beta1.manifest(KubeIpAddressV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.IPAddress”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeIpAddressV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddress”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.IPAddress”.
KubeJob ¶
Job represents the configuration of a single job.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeJob;
KubeJob.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(JobSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.JobSpec |
Specification of the desired behavior of a job. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.JobSpec
Specification of the desired behavior of a job.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.Job”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeJob;
KubeJob.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeJob;
KubeJob.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeJob;
KubeJob.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeJob;
KubeJob.manifest(),KubeJob.manifest(KubeJobProps props)
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.Job”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeJobProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.batch.v1.Job”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.batch.v1.Job”.
KubeJobList ¶
JobList is a collection of jobs.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeJobList;
KubeJobList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeJobProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of Jobs. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of Jobs.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.JobList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeJobList;
KubeJobList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeJobList;
KubeJobList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeJobList;
KubeJobList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeJobList;
KubeJobList.manifest(KubeJobListProps props)
Renders a Kubernetes manifest for “io.k8s.api.batch.v1.JobList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeJobListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.batch.v1.JobList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.batch.v1.JobList”.
KubeLease ¶
Lease defines a lease concept.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLease;
KubeLease.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(LeaseSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
spec |
org.cdk8s.plus36.k8s.LeaseSpec |
spec contains the specification of the Lease. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.LeaseSpec
spec contains the specification of the Lease.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.Lease”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLease;
KubeLease.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLease;
KubeLease.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLease;
KubeLease.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLease;
KubeLease.manifest(),KubeLease.manifest(KubeLeaseProps props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.Lease”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1.Lease”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1.Lease”.
KubeLeaseCandidateListV1Alpha2 ¶
LeaseCandidateList is a list of Lease objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2;
KubeLeaseCandidateListV1Alpha2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeLeaseCandidateV1Alpha2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2;
KubeLeaseCandidateListV1Alpha2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2;
KubeLeaseCandidateListV1Alpha2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2;
KubeLeaseCandidateListV1Alpha2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2;
KubeLeaseCandidateListV1Alpha2.manifest(KubeLeaseCandidateListV1Alpha2Props props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Alpha2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidateList”.
KubeLeaseCandidateListV1Beta1 ¶
LeaseCandidateList is a list of Lease objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1;
KubeLeaseCandidateListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeLeaseCandidateV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1;
KubeLeaseCandidateListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1;
KubeLeaseCandidateListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1;
KubeLeaseCandidateListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1;
KubeLeaseCandidateListV1Beta1.manifest(KubeLeaseCandidateListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseCandidateListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidateList”.
KubeLeaseCandidateV1Alpha2 ¶
LeaseCandidate defines a candidate for a Lease object.
Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2;
KubeLeaseCandidateV1Alpha2.Builder.create(Construct scope, java.lang.String id)
.spec(LeaseCandidateSpecV1Alpha2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.LeaseCandidateSpecV1Alpha2 |
spec contains the specification of the Lease. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.LeaseCandidateSpecV1Alpha2
spec contains the specification of the Lease.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2;
KubeLeaseCandidateV1Alpha2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2;
KubeLeaseCandidateV1Alpha2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2;
KubeLeaseCandidateV1Alpha2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2;
KubeLeaseCandidateV1Alpha2.manifest(KubeLeaseCandidateV1Alpha2Props props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Alpha2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1alpha2.LeaseCandidate”.
KubeLeaseCandidateV1Beta1 ¶
LeaseCandidate defines a candidate for a Lease object.
Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1;
KubeLeaseCandidateV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(LeaseCandidateSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.LeaseCandidateSpecV1Beta1 |
spec contains the specification of the Lease. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.LeaseCandidateSpecV1Beta1
spec contains the specification of the Lease.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1;
KubeLeaseCandidateV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1;
KubeLeaseCandidateV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1;
KubeLeaseCandidateV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1;
KubeLeaseCandidateV1Beta1.manifest(KubeLeaseCandidateV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseCandidateV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1beta1.LeaseCandidate”.
KubeLeaseList ¶
LeaseList is a list of Lease objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLeaseList;
KubeLeaseList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeLeaseProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.LeaseList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLeaseList;
KubeLeaseList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLeaseList;
KubeLeaseList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLeaseList;
KubeLeaseList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLeaseList;
KubeLeaseList.manifest(KubeLeaseListProps props)
Renders a Kubernetes manifest for “io.k8s.api.coordination.v1.LeaseList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLeaseListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.coordination.v1.LeaseList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.coordination.v1.LeaseList”.
KubeLimitRange ¶
LimitRange sets resource usage limits for each kind of resource in a Namespace.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLimitRange;
KubeLimitRange.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(LimitRangeSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.LimitRangeSpec |
Spec defines the limits enforced. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.LimitRangeSpec
Spec defines the limits enforced.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRange”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLimitRange;
KubeLimitRange.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLimitRange;
KubeLimitRange.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLimitRange;
KubeLimitRange.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLimitRange;
KubeLimitRange.manifest(),KubeLimitRange.manifest(KubeLimitRangeProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRange”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeLimitRangeProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRange”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRange”.
KubeLimitRangeList ¶
LimitRangeList is a list of LimitRange items.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLimitRangeList;
KubeLimitRangeList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeLimitRangeProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of LimitRange objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of LimitRange objects.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRangeList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLimitRangeList;
KubeLimitRangeList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLimitRangeList;
KubeLimitRangeList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLimitRangeList;
KubeLimitRangeList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLimitRangeList;
KubeLimitRangeList.manifest(KubeLimitRangeListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.LimitRangeList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLimitRangeListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRangeList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.LimitRangeList”.
KubeLocalSubjectAccessReview ¶
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace.
Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReview;
KubeLocalSubjectAccessReview.Builder.create(Construct scope, java.lang.String id)
.spec(SubjectAccessReviewSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.SubjectAccessReviewSpec |
spec holds information about the request being evaluated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.SubjectAccessReviewSpec
spec holds information about the request being evaluated.
spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReview;
KubeLocalSubjectAccessReview.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReview;
KubeLocalSubjectAccessReview.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReview;
KubeLocalSubjectAccessReview.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReview;
KubeLocalSubjectAccessReview.manifest(KubeLocalSubjectAccessReviewProps props)
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeLocalSubjectAccessReviewProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.LocalSubjectAccessReview”.
KubeMutatingAdmissionPolicy ¶
MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicy;
KubeMutatingAdmissionPolicy.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicySpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpec |
spec defines the desired behavior of the MutatingAdmissionPolicy. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpec
spec defines the desired behavior of the MutatingAdmissionPolicy.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicy”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicy;
KubeMutatingAdmissionPolicy.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicy;
KubeMutatingAdmissionPolicy.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicy;
KubeMutatingAdmissionPolicy.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicy;
KubeMutatingAdmissionPolicy.manifest(),KubeMutatingAdmissionPolicy.manifest(KubeMutatingAdmissionPolicyProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicy”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicy”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicy”.
KubeMutatingAdmissionPolicyBinding ¶
MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources.
MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.
Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBinding;
KubeMutatingAdmissionPolicyBinding.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicyBindingSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpec |
spec defines the desired behavior of the MutatingAdmissionPolicyBinding. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpec
spec defines the desired behavior of the MutatingAdmissionPolicyBinding.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBinding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBinding;
KubeMutatingAdmissionPolicyBinding.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBinding;
KubeMutatingAdmissionPolicyBinding.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBinding;
KubeMutatingAdmissionPolicyBinding.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBinding;
KubeMutatingAdmissionPolicyBinding.manifest(),KubeMutatingAdmissionPolicyBinding.manifest(KubeMutatingAdmissionPolicyBindingProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBinding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBinding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBinding”.
KubeMutatingAdmissionPolicyBindingList ¶
MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingList;
KubeMutatingAdmissionPolicyBindingList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyBindingProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of PolicyBinding. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of PolicyBinding.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBindingList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingList;
KubeMutatingAdmissionPolicyBindingList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingList;
KubeMutatingAdmissionPolicyBindingList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingList;
KubeMutatingAdmissionPolicyBindingList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingList;
KubeMutatingAdmissionPolicyBindingList.manifest(KubeMutatingAdmissionPolicyBindingListProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBindingList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBindingList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyBindingList”.
KubeMutatingAdmissionPolicyBindingListV1Alpha1 ¶
MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1;
KubeMutatingAdmissionPolicyBindingListV1Alpha1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyBindingV1Alpha1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of PolicyBinding. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of PolicyBinding.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1;
KubeMutatingAdmissionPolicyBindingListV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1;
KubeMutatingAdmissionPolicyBindingListV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1;
KubeMutatingAdmissionPolicyBindingListV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1;
KubeMutatingAdmissionPolicyBindingListV1Alpha1.manifest(KubeMutatingAdmissionPolicyBindingListV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBindingList”.
KubeMutatingAdmissionPolicyBindingListV1Beta1 ¶
MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1;
KubeMutatingAdmissionPolicyBindingListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyBindingV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of PolicyBinding. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of PolicyBinding.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1;
KubeMutatingAdmissionPolicyBindingListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1;
KubeMutatingAdmissionPolicyBindingListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1;
KubeMutatingAdmissionPolicyBindingListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1;
KubeMutatingAdmissionPolicyBindingListV1Beta1.manifest(KubeMutatingAdmissionPolicyBindingListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBindingList”.
KubeMutatingAdmissionPolicyBindingV1Alpha1 ¶
MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources.
MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.
Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1;
KubeMutatingAdmissionPolicyBindingV1Alpha1.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicyBindingSpecV1Alpha1)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1 |
spec defines the desired behavior of the MutatingAdmissionPolicyBinding. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpecV1Alpha1
spec defines the desired behavior of the MutatingAdmissionPolicyBinding.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1;
KubeMutatingAdmissionPolicyBindingV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1;
KubeMutatingAdmissionPolicyBindingV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1;
KubeMutatingAdmissionPolicyBindingV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1;
KubeMutatingAdmissionPolicyBindingV1Alpha1.manifest(),KubeMutatingAdmissionPolicyBindingV1Alpha1.manifest(KubeMutatingAdmissionPolicyBindingV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyBinding”.
KubeMutatingAdmissionPolicyBindingV1Beta1 ¶
MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources.
MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don’t use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.
Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1;
KubeMutatingAdmissionPolicyBindingV1Beta1.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicyBindingSpecV1Beta1)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpecV1Beta1 |
spec defines the desired behavior of the MutatingAdmissionPolicyBinding. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicyBindingSpecV1Beta1
spec defines the desired behavior of the MutatingAdmissionPolicyBinding.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1;
KubeMutatingAdmissionPolicyBindingV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1;
KubeMutatingAdmissionPolicyBindingV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1;
KubeMutatingAdmissionPolicyBindingV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1;
KubeMutatingAdmissionPolicyBindingV1Beta1.manifest(),KubeMutatingAdmissionPolicyBindingV1Beta1.manifest(KubeMutatingAdmissionPolicyBindingV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyBindingV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyBinding”.
KubeMutatingAdmissionPolicyList ¶
MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyList;
KubeMutatingAdmissionPolicyList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ValidatingAdmissionPolicy. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ValidatingAdmissionPolicy.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyList;
KubeMutatingAdmissionPolicyList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyList;
KubeMutatingAdmissionPolicyList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyList;
KubeMutatingAdmissionPolicyList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyList;
KubeMutatingAdmissionPolicyList.manifest(KubeMutatingAdmissionPolicyListProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingAdmissionPolicyList”.
KubeMutatingAdmissionPolicyListV1Alpha1 ¶
MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1;
KubeMutatingAdmissionPolicyListV1Alpha1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyV1Alpha1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ValidatingAdmissionPolicy. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ValidatingAdmissionPolicy.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1;
KubeMutatingAdmissionPolicyListV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1;
KubeMutatingAdmissionPolicyListV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1;
KubeMutatingAdmissionPolicyListV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1;
KubeMutatingAdmissionPolicyListV1Alpha1.manifest(KubeMutatingAdmissionPolicyListV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicyList”.
KubeMutatingAdmissionPolicyListV1Beta1 ¶
MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1;
KubeMutatingAdmissionPolicyListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingAdmissionPolicyV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ValidatingAdmissionPolicy. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ValidatingAdmissionPolicy.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1;
KubeMutatingAdmissionPolicyListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1;
KubeMutatingAdmissionPolicyListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1;
KubeMutatingAdmissionPolicyListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1;
KubeMutatingAdmissionPolicyListV1Beta1.manifest(KubeMutatingAdmissionPolicyListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicyList”.
KubeMutatingAdmissionPolicyV1Alpha1 ¶
MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1;
KubeMutatingAdmissionPolicyV1Alpha1.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicySpecV1Alpha1)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpecV1Alpha1 |
spec defines the desired behavior of the MutatingAdmissionPolicy. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpecV1Alpha1
spec defines the desired behavior of the MutatingAdmissionPolicy.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1;
KubeMutatingAdmissionPolicyV1Alpha1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1;
KubeMutatingAdmissionPolicyV1Alpha1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1;
KubeMutatingAdmissionPolicyV1Alpha1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1;
KubeMutatingAdmissionPolicyV1Alpha1.manifest(),KubeMutatingAdmissionPolicyV1Alpha1.manifest(KubeMutatingAdmissionPolicyV1Alpha1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Alpha1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1alpha1.MutatingAdmissionPolicy”.
KubeMutatingAdmissionPolicyV1Beta1 ¶
MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1;
KubeMutatingAdmissionPolicyV1Beta1.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(MutatingAdmissionPolicySpecV1Beta1)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
spec |
org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpecV1Beta1 |
spec defines the desired behavior of the MutatingAdmissionPolicy. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.MutatingAdmissionPolicySpecV1Beta1
spec defines the desired behavior of the MutatingAdmissionPolicy.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1;
KubeMutatingAdmissionPolicyV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1;
KubeMutatingAdmissionPolicyV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1;
KubeMutatingAdmissionPolicyV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1;
KubeMutatingAdmissionPolicyV1Beta1.manifest(),KubeMutatingAdmissionPolicyV1Beta1.manifest(KubeMutatingAdmissionPolicyV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingAdmissionPolicyV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1beta1.MutatingAdmissionPolicy”.
KubeMutatingWebhookConfiguration ¶
MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfiguration;
KubeMutatingWebhookConfiguration.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .webhooks(java.util.List<MutatingWebhook>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object metadata; |
webhooks |
java.util.List |
webhooks is a list of webhooks and the affected resources and operations. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
webhooksOptional ¶
- Type: java.util.List
webhooks is a list of webhooks and the affected resources and operations.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfiguration;
KubeMutatingWebhookConfiguration.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfiguration;
KubeMutatingWebhookConfiguration.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfiguration;
KubeMutatingWebhookConfiguration.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfiguration;
KubeMutatingWebhookConfiguration.manifest(),KubeMutatingWebhookConfiguration.manifest(KubeMutatingWebhookConfigurationProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration”.
KubeMutatingWebhookConfigurationList ¶
MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationList;
KubeMutatingWebhookConfigurationList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeMutatingWebhookConfigurationProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of MutatingWebhookConfiguration. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of MutatingWebhookConfiguration.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationList;
KubeMutatingWebhookConfigurationList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationList;
KubeMutatingWebhookConfigurationList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationList;
KubeMutatingWebhookConfigurationList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationList;
KubeMutatingWebhookConfigurationList.manifest(KubeMutatingWebhookConfigurationListProps props)
Renders a Kubernetes manifest for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeMutatingWebhookConfigurationListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList”.
KubeNamespace ¶
Namespace provides a scope for Names.
Use of multiple namespaces is optional.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNamespace;
KubeNamespace.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(NamespaceSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.NamespaceSpec |
Spec defines the behavior of the Namespace. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.NamespaceSpec
Spec defines the behavior of the Namespace.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Namespace”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNamespace;
KubeNamespace.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNamespace;
KubeNamespace.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNamespace;
KubeNamespace.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNamespace;
KubeNamespace.manifest(),KubeNamespace.manifest(KubeNamespaceProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Namespace”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeNamespaceProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Namespace”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Namespace”.
KubeNamespaceList ¶
NamespaceList is a list of Namespaces.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNamespaceList;
KubeNamespaceList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeNamespaceProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of Namespace objects in the list. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of Namespace objects in the list.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.NamespaceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNamespaceList;
KubeNamespaceList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNamespaceList;
KubeNamespaceList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNamespaceList;
KubeNamespaceList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNamespaceList;
KubeNamespaceList.manifest(KubeNamespaceListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.NamespaceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeNamespaceListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.NamespaceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.NamespaceList”.
KubeNetworkPolicy ¶
NetworkPolicy describes what network traffic is allowed for a set of Pods.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicy;
KubeNetworkPolicy.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(NetworkPolicySpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.NetworkPolicySpec |
spec represents the specification of the desired behavior for this NetworkPolicy. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.NetworkPolicySpec
spec represents the specification of the desired behavior for this NetworkPolicy.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicy”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicy;
KubeNetworkPolicy.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicy;
KubeNetworkPolicy.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicy;
KubeNetworkPolicy.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicy;
KubeNetworkPolicy.manifest(),KubeNetworkPolicy.manifest(KubeNetworkPolicyProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicy”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeNetworkPolicyProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicy”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicy”.
KubeNetworkPolicyList ¶
NetworkPolicyList is a list of NetworkPolicy objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicyList;
KubeNetworkPolicyList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeNetworkPolicyProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicyList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicyList;
KubeNetworkPolicyList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicyList;
KubeNetworkPolicyList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicyList;
KubeNetworkPolicyList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNetworkPolicyList;
KubeNetworkPolicyList.manifest(KubeNetworkPolicyListProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.NetworkPolicyList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeNetworkPolicyListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicyList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.NetworkPolicyList”.
KubeNode ¶
Node is a worker node in Kubernetes.
Each node will have a unique identifier in the cache (i.e. in etcd).
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNode;
KubeNode.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(NodeSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.NodeSpec |
Spec defines the behavior of a node. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.NodeSpec
Spec defines the behavior of a node.
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Node”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNode;
KubeNode.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNode;
KubeNode.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNode;
KubeNode.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNode;
KubeNode.manifest(),KubeNode.manifest(KubeNodeProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Node”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeNodeProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Node”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Node”.
KubeNodeList ¶
NodeList is the whole list of all Nodes which have been registered with master.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeNodeList;
KubeNodeList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeNodeProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of nodes. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of nodes.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.NodeList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeNodeList;
KubeNodeList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeNodeList;
KubeNodeList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeNodeList;
KubeNodeList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeNodeList;
KubeNodeList.manifest(KubeNodeListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.NodeList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeNodeListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.NodeList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.NodeList”.
KubePersistentVolume ¶
PersistentVolume (PV) is a storage resource provisioned by an administrator.
It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
Initializers ¶
import org.cdk8s.plus36.k8s.KubePersistentVolume;
KubePersistentVolume.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(PersistentVolumeSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.PersistentVolumeSpec |
spec defines a specification of a persistent volume owned by the cluster. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.PersistentVolumeSpec
spec defines a specification of a persistent volume owned by the cluster.
Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolume”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePersistentVolume;
KubePersistentVolume.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePersistentVolume;
KubePersistentVolume.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePersistentVolume;
KubePersistentVolume.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePersistentVolume;
KubePersistentVolume.manifest(),KubePersistentVolume.manifest(KubePersistentVolumeProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolume”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePersistentVolumeProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolume”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolume”.
KubePersistentVolumeClaim ¶
PersistentVolumeClaim is a user’s request for and claim to a persistent volume.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaim;
KubePersistentVolumeClaim.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(PersistentVolumeClaimSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.PersistentVolumeClaimSpec |
spec defines the desired characteristics of a volume requested by a pod author. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.PersistentVolumeClaimSpec
spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaim”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaim;
KubePersistentVolumeClaim.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaim;
KubePersistentVolumeClaim.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaim;
KubePersistentVolumeClaim.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaim;
KubePersistentVolumeClaim.manifest(),KubePersistentVolumeClaim.manifest(KubePersistentVolumeClaimProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaim”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePersistentVolumeClaimProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaim”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaim”.
KubePersistentVolumeClaimList ¶
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaimList;
KubePersistentVolumeClaimList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePersistentVolumeClaimProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of persistent volume claims. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of persistent volume claims.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaimList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaimList;
KubePersistentVolumeClaimList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaimList;
KubePersistentVolumeClaimList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaimList;
KubePersistentVolumeClaimList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeClaimList;
KubePersistentVolumeClaimList.manifest(KubePersistentVolumeClaimListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeClaimList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePersistentVolumeClaimListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaimList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeClaimList”.
KubePersistentVolumeList ¶
PersistentVolumeList is a list of PersistentVolume items.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeList;
KubePersistentVolumeList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePersistentVolumeProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of persistent volumes. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of persistent volumes.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeList;
KubePersistentVolumeList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeList;
KubePersistentVolumeList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeList;
KubePersistentVolumeList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePersistentVolumeList;
KubePersistentVolumeList.manifest(KubePersistentVolumeListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PersistentVolumeList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePersistentVolumeListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PersistentVolumeList”.
KubePod ¶
Pod is a collection of containers that can run on a host.
This resource is created by clients and scheduled onto hosts.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePod;
KubePod.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(PodSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.PodSpec |
Specification of the desired behavior of the pod. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.PodSpec
Specification of the desired behavior of the pod.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Pod”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePod;
KubePod.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePod;
KubePod.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePod;
KubePod.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePod;
KubePod.manifest(),KubePod.manifest(KubePodProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Pod”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePodProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Pod”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Pod”.
KubePodCertificateRequestListV1Beta1 ¶
PodCertificateRequestList is a collection of PodCertificateRequest objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1;
KubePodCertificateRequestListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePodCertificateRequestV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a collection of PodCertificateRequest objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata contains the list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a collection of PodCertificateRequest objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata contains the list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.PodCertificateRequestList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1;
KubePodCertificateRequestListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1;
KubePodCertificateRequestListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1;
KubePodCertificateRequestListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1;
KubePodCertificateRequestListV1Beta1.manifest(KubePodCertificateRequestListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.PodCertificateRequestList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodCertificateRequestListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.PodCertificateRequestList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.PodCertificateRequestList”.
KubePodCertificateRequestV1Beta1 ¶
PodCertificateRequest encodes a pod requesting a certificate from a given signer.
Kubelets use this API to implement podCertificate projected volumes
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1;
KubePodCertificateRequestV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(PodCertificateRequestSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.PodCertificateRequestSpecV1Beta1 |
spec contains the details about the certificate being requested. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata contains the object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.PodCertificateRequestSpecV1Beta1
spec contains the details about the certificate being requested.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata contains the object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.PodCertificateRequest”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1;
KubePodCertificateRequestV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1;
KubePodCertificateRequestV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1;
KubePodCertificateRequestV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1;
KubePodCertificateRequestV1Beta1.manifest(KubePodCertificateRequestV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.certificates.v1beta1.PodCertificateRequest”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodCertificateRequestV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.PodCertificateRequest”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.certificates.v1beta1.PodCertificateRequest”.
KubePodDisruptionBudget ¶
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudget;
KubePodDisruptionBudget.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(PodDisruptionBudgetSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.PodDisruptionBudgetSpec |
Specification of the desired behavior of the PodDisruptionBudget. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.PodDisruptionBudgetSpec
Specification of the desired behavior of the PodDisruptionBudget.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudget”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudget;
KubePodDisruptionBudget.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudget;
KubePodDisruptionBudget.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudget;
KubePodDisruptionBudget.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudget;
KubePodDisruptionBudget.manifest(),KubePodDisruptionBudget.manifest(KubePodDisruptionBudgetProps props)
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudget”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePodDisruptionBudgetProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudget”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudget”.
KubePodDisruptionBudgetList ¶
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudgetList;
KubePodDisruptionBudgetList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePodDisruptionBudgetProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of PodDisruptionBudgets. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of PodDisruptionBudgets.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudgetList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudgetList;
KubePodDisruptionBudgetList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudgetList;
KubePodDisruptionBudgetList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudgetList;
KubePodDisruptionBudgetList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodDisruptionBudgetList;
KubePodDisruptionBudgetList.manifest(KubePodDisruptionBudgetListProps props)
Renders a Kubernetes manifest for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodDisruptionBudgetListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudgetList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.policy.v1.PodDisruptionBudgetList”.
KubePodGroupListV1Alpha2 ¶
PodGroupList contains a list of PodGroup resources.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2;
KubePodGroupListV1Alpha2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePodGroupV1Alpha2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of PodGroups. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of PodGroups.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1alpha2.PodGroupList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2;
KubePodGroupListV1Alpha2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2;
KubePodGroupListV1Alpha2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2;
KubePodGroupListV1Alpha2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2;
KubePodGroupListV1Alpha2.manifest(KubePodGroupListV1Alpha2Props props)
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1alpha2.PodGroupList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodGroupListV1Alpha2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1alpha2.PodGroupList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1alpha2.PodGroupList”.
KubePodGroupV1Alpha2 ¶
PodGroup represents a runtime instance of pods grouped together.
PodGroups are created by workload controllers (Job, LWS, JobSet, etc…) from Workload.podGroupTemplates. PodGroup API enablement is toggled by the GenericWorkload feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2;
KubePodGroupV1Alpha2.Builder.create(Construct scope, java.lang.String id)
.spec(PodGroupSpecV1Alpha2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.PodGroupSpecV1Alpha2 |
Spec defines the desired state of the PodGroup. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.PodGroupSpecV1Alpha2
Spec defines the desired state of the PodGroup.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1alpha2.PodGroup”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2;
KubePodGroupV1Alpha2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2;
KubePodGroupV1Alpha2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2;
KubePodGroupV1Alpha2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2;
KubePodGroupV1Alpha2.manifest(KubePodGroupV1Alpha2Props props)
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1alpha2.PodGroup”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodGroupV1Alpha2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1alpha2.PodGroup”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1alpha2.PodGroup”.
KubePodList ¶
PodList is a list of Pods.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodList;
KubePodList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePodProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of pods. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of pods.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodList;
KubePodList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodList;
KubePodList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodList;
KubePodList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodList;
KubePodList.manifest(KubePodListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodList”.
KubePodTemplate ¶
PodTemplate describes a template for creating copies of a predefined pod.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodTemplate;
KubePodTemplate.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .template(PodTemplateSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
template |
org.cdk8s.plus36.k8s.PodTemplateSpec |
Template defines the pods that will be created from this pod template. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
templateOptional ¶
- Type: org.cdk8s.plus36.k8s.PodTemplateSpec
Template defines the pods that will be created from this pod template.
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodTemplate;
KubePodTemplate.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodTemplate;
KubePodTemplate.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodTemplate;
KubePodTemplate.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodTemplate;
KubePodTemplate.manifest(),KubePodTemplate.manifest(KubePodTemplateProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePodTemplateProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplate”.
KubePodTemplateList ¶
PodTemplateList is a list of PodTemplates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePodTemplateList;
KubePodTemplateList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePodTemplateProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of pod templates. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of pod templates.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePodTemplateList;
KubePodTemplateList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePodTemplateList;
KubePodTemplateList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePodTemplateList;
KubePodTemplateList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePodTemplateList;
KubePodTemplateList.manifest(KubePodTemplateListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.PodTemplateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePodTemplateListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.PodTemplateList”.
KubePriorityClass ¶
PriorityClass defines mapping from a priority class name to the priority integer value.
The value can be any valid integer.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePriorityClass;
KubePriorityClass.Builder.create(Construct scope, java.lang.String id)
// .description(java.lang.String)
// .globalDefault(java.lang.Boolean)
// .metadata(ObjectMeta)
// .preemptionPolicy(java.lang.String)
// .value(java.lang.Number)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
description |
java.lang.String |
description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefault |
java.lang.Boolean |
globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
preemptionPolicy |
java.lang.String |
preemptionPolicy is the Policy for preempting pods with lower priority. |
value |
java.lang.Number |
value represents the integer value of this priority class. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
descriptionOptional ¶
- Type: java.lang.String
description is an arbitrary string that usually provides guidelines on when this priority class should be used.
globalDefaultOptional ¶
- Type: java.lang.Boolean
globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class.
Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
preemptionPolicyOptional ¶
- Type: java.lang.String
- Default: PreemptLowerPriority if unset.
preemptionPolicy is the Policy for preempting pods with lower priority.
One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
valueOptional ¶
- Type: java.lang.Number
value represents the integer value of this priority class.
This is the actual priority that pods receive when they have the name of this class in their pod spec.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePriorityClass;
KubePriorityClass.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePriorityClass;
KubePriorityClass.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePriorityClass;
KubePriorityClass.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePriorityClass;
KubePriorityClass.manifest(),KubePriorityClass.manifest(KubePriorityClassProps props)
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePriorityClassProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClass”.
KubePriorityClassList ¶
PriorityClassList is a collection of priority classes.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePriorityClassList;
KubePriorityClassList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePriorityClassProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of PriorityClasses. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of PriorityClasses.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePriorityClassList;
KubePriorityClassList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePriorityClassList;
KubePriorityClassList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePriorityClassList;
KubePriorityClassList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePriorityClassList;
KubePriorityClassList.manifest(KubePriorityClassListProps props)
Renders a Kubernetes manifest for “io.k8s.api.scheduling.v1.PriorityClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePriorityClassListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.scheduling.v1.PriorityClassList”.
KubePriorityLevelConfiguration ¶
PriorityLevelConfiguration represents the configuration of a priority level.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfiguration;
KubePriorityLevelConfiguration.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(PriorityLevelConfigurationSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.PriorityLevelConfigurationSpec |
spec is the specification of the desired behavior of a “request-priority”. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.PriorityLevelConfigurationSpec
spec is the specification of the desired behavior of a “request-priority”.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfiguration;
KubePriorityLevelConfiguration.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfiguration;
KubePriorityLevelConfiguration.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfiguration;
KubePriorityLevelConfiguration.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfiguration;
KubePriorityLevelConfiguration.manifest(),KubePriorityLevelConfiguration.manifest(KubePriorityLevelConfigurationProps props)
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfiguration”.
KubePriorityLevelConfigurationList ¶
PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationList;
KubePriorityLevelConfigurationList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubePriorityLevelConfigurationProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of request-priorities. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
metadata is the standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of request-priorities.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
metadata is the standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationList;
KubePriorityLevelConfigurationList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationList;
KubePriorityLevelConfigurationList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationList;
KubePriorityLevelConfigurationList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationList;
KubePriorityLevelConfigurationList.manifest(KubePriorityLevelConfigurationListProps props)
Renders a Kubernetes manifest for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubePriorityLevelConfigurationListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.flowcontrol.v1.PriorityLevelConfigurationList”.
KubeReplicaSet ¶
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeReplicaSet;
KubeReplicaSet.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ReplicaSetSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. |
spec |
org.cdk8s.plus36.k8s.ReplicaSetSpec |
Spec defines the specification of the desired behavior of the ReplicaSet. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages.
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ReplicaSetSpec
Spec defines the specification of the desired behavior of the ReplicaSet.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSet”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeReplicaSet;
KubeReplicaSet.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeReplicaSet;
KubeReplicaSet.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeReplicaSet;
KubeReplicaSet.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeReplicaSet;
KubeReplicaSet.manifest(),KubeReplicaSet.manifest(KubeReplicaSetProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSet”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeReplicaSetProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSet”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSet”.
KubeReplicaSetList ¶
ReplicaSetList is a collection of ReplicaSets.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeReplicaSetList;
KubeReplicaSetList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeReplicaSetProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ReplicaSets. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ReplicaSets.
More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSetList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeReplicaSetList;
KubeReplicaSetList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeReplicaSetList;
KubeReplicaSetList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeReplicaSetList;
KubeReplicaSetList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeReplicaSetList;
KubeReplicaSetList.manifest(KubeReplicaSetListProps props)
Renders a Kubernetes manifest for “io.k8s.api.apps.v1.ReplicaSetList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeReplicaSetListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSetList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.apps.v1.ReplicaSetList”.
KubeReplicationController ¶
ReplicationController represents the configuration of a replication controller.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeReplicationController;
KubeReplicationController.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ReplicationControllerSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. |
spec |
org.cdk8s.plus36.k8s.ReplicationControllerSpec |
Spec defines the specification of the desired behavior of the replication controller. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages.
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ReplicationControllerSpec
Spec defines the specification of the desired behavior of the replication controller.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationController”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeReplicationController;
KubeReplicationController.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeReplicationController;
KubeReplicationController.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeReplicationController;
KubeReplicationController.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeReplicationController;
KubeReplicationController.manifest(),KubeReplicationController.manifest(KubeReplicationControllerProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationController”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeReplicationControllerProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationController”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationController”.
KubeReplicationControllerList ¶
ReplicationControllerList is a collection of replication controllers.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeReplicationControllerList;
KubeReplicationControllerList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeReplicationControllerProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of replication controllers. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of replication controllers.
More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationControllerList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeReplicationControllerList;
KubeReplicationControllerList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeReplicationControllerList;
KubeReplicationControllerList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeReplicationControllerList;
KubeReplicationControllerList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeReplicationControllerList;
KubeReplicationControllerList.manifest(KubeReplicationControllerListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ReplicationControllerList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeReplicationControllerListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationControllerList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ReplicationControllerList”.
KubeResourceClaim ¶
ResourceClaim describes a request for access to resources in the cluster, for use by workloads.
For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaim;
KubeResourceClaim.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimSpec |
Spec describes what is being requested and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimSpec
Spec describes what is being requested and how to configure it.
The spec is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaim”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaim;
KubeResourceClaim.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaim;
KubeResourceClaim.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaim;
KubeResourceClaim.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaim;
KubeResourceClaim.manifest(KubeResourceClaimProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaim”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaim”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaim”.
KubeResourceClaimList ¶
ResourceClaimList is a collection of claims.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimList;
KubeResourceClaimList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claims. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claims.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimList;
KubeResourceClaimList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimList;
KubeResourceClaimList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimList;
KubeResourceClaimList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimList;
KubeResourceClaimList.manifest(KubeResourceClaimListProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimList”.
KubeResourceClaimListV1Beta1 ¶
ResourceClaimList is a collection of claims.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1;
KubeResourceClaimListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claims. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claims.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1;
KubeResourceClaimListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1;
KubeResourceClaimListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1;
KubeResourceClaimListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1;
KubeResourceClaimListV1Beta1.manifest(KubeResourceClaimListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimList”.
KubeResourceClaimListV1Beta2 ¶
ResourceClaimList is a collection of claims.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2;
KubeResourceClaimListV1Beta2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimV1Beta2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claims. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claims.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2;
KubeResourceClaimListV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2;
KubeResourceClaimListV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2;
KubeResourceClaimListV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2;
KubeResourceClaimListV1Beta2.manifest(KubeResourceClaimListV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimListV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimList”.
KubeResourceClaimTemplate ¶
ResourceClaimTemplate is used to produce ResourceClaim objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplate;
KubeResourceClaimTemplate.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimTemplateSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimTemplateSpec |
Describes the ResourceClaim that is to be generated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimTemplateSpec
Describes the ResourceClaim that is to be generated.
This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplate;
KubeResourceClaimTemplate.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplate;
KubeResourceClaimTemplate.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplate;
KubeResourceClaimTemplate.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplate;
KubeResourceClaimTemplate.manifest(KubeResourceClaimTemplateProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplate”.
KubeResourceClaimTemplateList ¶
ResourceClaimTemplateList is a collection of claim templates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateList;
KubeResourceClaimTemplateList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimTemplateProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claim templates. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claim templates.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateList;
KubeResourceClaimTemplateList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateList;
KubeResourceClaimTemplateList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateList;
KubeResourceClaimTemplateList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateList;
KubeResourceClaimTemplateList.manifest(KubeResourceClaimTemplateListProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceClaimTemplateList”.
KubeResourceClaimTemplateListV1Beta1 ¶
ResourceClaimTemplateList is a collection of claim templates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1;
KubeResourceClaimTemplateListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimTemplateV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claim templates. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claim templates.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1;
KubeResourceClaimTemplateListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1;
KubeResourceClaimTemplateListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1;
KubeResourceClaimTemplateListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1;
KubeResourceClaimTemplateListV1Beta1.manifest(KubeResourceClaimTemplateListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplateList”.
KubeResourceClaimTemplateListV1Beta2 ¶
ResourceClaimTemplateList is a collection of claim templates.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2;
KubeResourceClaimTemplateListV1Beta2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceClaimTemplateV1Beta2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource claim templates. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource claim templates.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2;
KubeResourceClaimTemplateListV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2;
KubeResourceClaimTemplateListV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2;
KubeResourceClaimTemplateListV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2;
KubeResourceClaimTemplateListV1Beta2.manifest(KubeResourceClaimTemplateListV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateListV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplateList”.
KubeResourceClaimTemplateV1Beta1 ¶
ResourceClaimTemplate is used to produce ResourceClaim objects.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1;
KubeResourceClaimTemplateV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimTemplateSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimTemplateSpecV1Beta1 |
Describes the ResourceClaim that is to be generated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimTemplateSpecV1Beta1
Describes the ResourceClaim that is to be generated.
This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1;
KubeResourceClaimTemplateV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1;
KubeResourceClaimTemplateV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1;
KubeResourceClaimTemplateV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1;
KubeResourceClaimTemplateV1Beta1.manifest(KubeResourceClaimTemplateV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaimTemplate”.
KubeResourceClaimTemplateV1Beta2 ¶
ResourceClaimTemplate is used to produce ResourceClaim objects.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2;
KubeResourceClaimTemplateV1Beta2.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimTemplateSpecV1Beta2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimTemplateSpecV1Beta2 |
Describes the ResourceClaim that is to be generated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimTemplateSpecV1Beta2
Describes the ResourceClaim that is to be generated.
This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2;
KubeResourceClaimTemplateV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2;
KubeResourceClaimTemplateV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2;
KubeResourceClaimTemplateV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2;
KubeResourceClaimTemplateV1Beta2.manifest(KubeResourceClaimTemplateV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimTemplateV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaimTemplate”.
KubeResourceClaimV1Beta1 ¶
ResourceClaim describes a request for access to resources in the cluster, for use by workloads.
For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1;
KubeResourceClaimV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimSpecV1Beta1 |
Spec describes what is being requested and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimSpecV1Beta1
Spec describes what is being requested and how to configure it.
The spec is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaim”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1;
KubeResourceClaimV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1;
KubeResourceClaimV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1;
KubeResourceClaimV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1;
KubeResourceClaimV1Beta1.manifest(KubeResourceClaimV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceClaim”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaim”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceClaim”.
KubeResourceClaimV1Beta2 ¶
ResourceClaim describes a request for access to resources in the cluster, for use by workloads.
For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2;
KubeResourceClaimV1Beta2.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceClaimSpecV1Beta2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceClaimSpecV1Beta2 |
Spec describes what is being requested and how to configure it. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceClaimSpecV1Beta2
Spec describes what is being requested and how to configure it.
The spec is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaim”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2;
KubeResourceClaimV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2;
KubeResourceClaimV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2;
KubeResourceClaimV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2;
KubeResourceClaimV1Beta2.manifest(KubeResourceClaimV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceClaim”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceClaimV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaim”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceClaim”.
KubeResourcePoolStatusRequestListV1Alpha3 ¶
ResourcePoolStatusRequestList is a collection of ResourcePoolStatusRequests.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3;
KubeResourcePoolStatusRequestListV1Alpha3.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourcePoolStatusRequestV1Alpha3Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of ResourcePoolStatusRequests. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of ResourcePoolStatusRequests.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequestList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3;
KubeResourcePoolStatusRequestListV1Alpha3.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3;
KubeResourcePoolStatusRequestListV1Alpha3.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3;
KubeResourcePoolStatusRequestListV1Alpha3.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3;
KubeResourcePoolStatusRequestListV1Alpha3.manifest(KubeResourcePoolStatusRequestListV1Alpha3Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequestList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestListV1Alpha3Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequestList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequestList”.
KubeResourcePoolStatusRequestV1Alpha3 ¶
ResourcePoolStatusRequest triggers a one-time calculation of resource pool status based on the provided filters.
Once status is set, the request is considered complete and will not be reprocessed. Users should delete and recreate requests to get updated information.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3;
KubeResourcePoolStatusRequestV1Alpha3.Builder.create(Construct scope, java.lang.String id)
.metadata(ObjectMeta)
.spec(ResourcePoolStatusRequestSpecV1Alpha3)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
spec |
org.cdk8s.plus36.k8s.ResourcePoolStatusRequestSpecV1Alpha3 |
Spec defines the filters for which pools to include in the status. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataRequired ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourcePoolStatusRequestSpecV1Alpha3
Spec defines the filters for which pools to include in the status.
The spec is immutable once created.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequest”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3;
KubeResourcePoolStatusRequestV1Alpha3.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3;
KubeResourcePoolStatusRequestV1Alpha3.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3;
KubeResourcePoolStatusRequestV1Alpha3.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3;
KubeResourcePoolStatusRequestV1Alpha3.manifest(KubeResourcePoolStatusRequestV1Alpha3Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequest”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourcePoolStatusRequestV1Alpha3Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequest”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1alpha3.ResourcePoolStatusRequest”.
KubeResourceQuota ¶
ResourceQuota sets aggregate quota restrictions enforced per namespace.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceQuota;
KubeResourceQuota.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ResourceQuotaSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.ResourceQuotaSpec |
Spec defines the desired quota. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ResourceQuotaSpec
Spec defines the desired quota.
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuota”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceQuota;
KubeResourceQuota.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceQuota;
KubeResourceQuota.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceQuota;
KubeResourceQuota.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceQuota;
KubeResourceQuota.manifest(),KubeResourceQuota.manifest(KubeResourceQuotaProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuota”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceQuotaProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuota”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuota”.
KubeResourceQuotaList ¶
ResourceQuotaList is a list of ResourceQuota items.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceQuotaList;
KubeResourceQuotaList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceQuotaProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of ResourceQuota objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of ResourceQuota objects.
More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuotaList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceQuotaList;
KubeResourceQuotaList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceQuotaList;
KubeResourceQuotaList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceQuotaList;
KubeResourceQuotaList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceQuotaList;
KubeResourceQuotaList.manifest(KubeResourceQuotaListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ResourceQuotaList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceQuotaListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuotaList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ResourceQuotaList”.
KubeResourceSlice ¶
ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.
A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple
Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSlice;
KubeResourceSlice.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceSliceSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceSliceSpec |
Contains the information published by the driver. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceSliceSpec
Contains the information published by the driver.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSlice”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSlice;
KubeResourceSlice.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSlice;
KubeResourceSlice.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSlice;
KubeResourceSlice.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSlice;
KubeResourceSlice.manifest(KubeResourceSliceProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSlice”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSlice”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSlice”.
KubeResourceSliceList ¶
ResourceSliceList is a collection of ResourceSlices.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceList;
KubeResourceSliceList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceSliceProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource ResourceSlices. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource ResourceSlices.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSliceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceList;
KubeResourceSliceList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceList;
KubeResourceSliceList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceList;
KubeResourceSliceList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceList;
KubeResourceSliceList.manifest(KubeResourceSliceListProps props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1.ResourceSliceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSliceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1.ResourceSliceList”.
KubeResourceSliceListV1Beta1 ¶
ResourceSliceList is a collection of ResourceSlices.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1;
KubeResourceSliceListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceSliceV1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource ResourceSlices. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource ResourceSlices.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSliceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1;
KubeResourceSliceListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1;
KubeResourceSliceListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1;
KubeResourceSliceListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1;
KubeResourceSliceListV1Beta1.manifest(KubeResourceSliceListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSliceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSliceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSliceList”.
KubeResourceSliceListV1Beta2 ¶
ResourceSliceList is a collection of ResourceSlices.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2;
KubeResourceSliceListV1Beta2.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeResourceSliceV1Beta2Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is the list of resource ResourceSlices. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is the list of resource ResourceSlices.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSliceList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2;
KubeResourceSliceListV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2;
KubeResourceSliceListV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2;
KubeResourceSliceListV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2;
KubeResourceSliceListV1Beta2.manifest(KubeResourceSliceListV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSliceList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceListV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSliceList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSliceList”.
KubeResourceSliceV1Beta1 ¶
ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.
A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple
Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1;
KubeResourceSliceV1Beta1.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceSliceSpecV1Beta1)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceSliceSpecV1Beta1 |
Contains the information published by the driver. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceSliceSpecV1Beta1
Contains the information published by the driver.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSlice”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1;
KubeResourceSliceV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1;
KubeResourceSliceV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1;
KubeResourceSliceV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1;
KubeResourceSliceV1Beta1.manifest(KubeResourceSliceV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta1.ResourceSlice”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSlice”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta1.ResourceSlice”.
KubeResourceSliceV1Beta2 ¶
ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.
A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple
Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2;
KubeResourceSliceV1Beta2.Builder.create(Construct scope, java.lang.String id)
.spec(ResourceSliceSpecV1Beta2)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.ResourceSliceSpecV1Beta2 |
Contains the information published by the driver. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.ResourceSliceSpecV1Beta2
Contains the information published by the driver.
Changing the spec automatically increments the metadata.generation number.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSlice”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2;
KubeResourceSliceV1Beta2.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2;
KubeResourceSliceV1Beta2.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2;
KubeResourceSliceV1Beta2.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2;
KubeResourceSliceV1Beta2.manifest(KubeResourceSliceV1Beta2Props props)
Renders a Kubernetes manifest for “io.k8s.api.resource.v1beta2.ResourceSlice”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeResourceSliceV1Beta2Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSlice”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.resource.v1beta2.ResourceSlice”.
KubeRole ¶
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRole;
KubeRole.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .rules(java.util.List<PolicyRule>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
rules |
java.util.List |
Rules holds all the PolicyRules for this Role. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
rulesOptional ¶
- Type: java.util.List
Rules holds all the PolicyRules for this Role.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.Role”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRole;
KubeRole.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRole;
KubeRole.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRole;
KubeRole.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRole;
KubeRole.manifest(),KubeRole.manifest(KubeRoleProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.Role”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeRoleProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.Role”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.Role”.
KubeRoleBinding ¶
RoleBinding references a role, but does not contain it.
It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRoleBinding;
KubeRoleBinding.Builder.create(Construct scope, java.lang.String id)
.roleRef(RoleRef)
// .metadata(ObjectMeta)
// .subjects(java.util.List<Subject>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
roleRef |
org.cdk8s.plus36.k8s.RoleRef |
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
subjects |
java.util.List |
Subjects holds references to the objects the role applies to. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
roleRefRequired ¶
- Type: org.cdk8s.plus36.k8s.RoleRef
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace.
If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
subjectsOptional ¶
- Type: java.util.List
Subjects holds references to the objects the role applies to.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBinding”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRoleBinding;
KubeRoleBinding.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRoleBinding;
KubeRoleBinding.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRoleBinding;
KubeRoleBinding.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRoleBinding;
KubeRoleBinding.manifest(KubeRoleBindingProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBinding”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeRoleBindingProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBinding”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBinding”.
KubeRoleBindingList ¶
RoleBindingList is a collection of RoleBindings.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRoleBindingList;
KubeRoleBindingList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeRoleBindingProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of RoleBindings. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of RoleBindings.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBindingList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRoleBindingList;
KubeRoleBindingList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRoleBindingList;
KubeRoleBindingList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRoleBindingList;
KubeRoleBindingList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRoleBindingList;
KubeRoleBindingList.manifest(KubeRoleBindingListProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleBindingList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeRoleBindingListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBindingList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleBindingList”.
KubeRoleList ¶
RoleList is a collection of Roles.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRoleList;
KubeRoleList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeRoleProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of Roles. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of Roles.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRoleList;
KubeRoleList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRoleList;
KubeRoleList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRoleList;
KubeRoleList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRoleList;
KubeRoleList.manifest(KubeRoleListProps props)
Renders a Kubernetes manifest for “io.k8s.api.rbac.v1.RoleList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeRoleListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.rbac.v1.RoleList”.
KubeRuntimeClass ¶
RuntimeClass defines a class of container runtime supported in the cluster.
The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClass;
KubeRuntimeClass.Builder.create(Construct scope, java.lang.String id)
.handler(java.lang.String)
// .metadata(ObjectMeta)
// .overhead(Overhead)
// .scheduling(Scheduling)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
handler |
java.lang.String |
handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
overhead |
org.cdk8s.plus36.k8s.Overhead |
overhead represents the resource overhead associated with running a pod for a given RuntimeClass. |
scheduling |
org.cdk8s.plus36.k8s.Scheduling |
scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
handlerRequired ¶
- Type: java.lang.String
handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class.
The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called “runc” might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
overheadOptional ¶
- Type: org.cdk8s.plus36.k8s.Overhead
overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
For more details, see https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
schedulingOptional ¶
- Type: org.cdk8s.plus36.k8s.Scheduling
scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it.
If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClass”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClass;
KubeRuntimeClass.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClass;
KubeRuntimeClass.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClass;
KubeRuntimeClass.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClass;
KubeRuntimeClass.manifest(KubeRuntimeClassProps props)
Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClass”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeRuntimeClassProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClass”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClass”.
KubeRuntimeClassList ¶
RuntimeClassList is a list of RuntimeClass objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClassList;
KubeRuntimeClassList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeRuntimeClassProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is a list of schema objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is a list of schema objects.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClassList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClassList;
KubeRuntimeClassList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClassList;
KubeRuntimeClassList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClassList;
KubeRuntimeClassList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeRuntimeClassList;
KubeRuntimeClassList.manifest(KubeRuntimeClassListProps props)
Renders a Kubernetes manifest for “io.k8s.api.node.v1.RuntimeClassList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeRuntimeClassListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClassList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.node.v1.RuntimeClassList”.
KubeScale ¶
Scale represents a scaling request for a resource.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeScale;
KubeScale.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ScaleSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object metadata; |
spec |
org.cdk8s.plus36.k8s.ScaleSpec |
spec defines the behavior of the scale. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object metadata;
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ScaleSpec
spec defines the behavior of the scale.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.Scale”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeScale;
KubeScale.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeScale;
KubeScale.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeScale;
KubeScale.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeScale;
KubeScale.manifest(),KubeScale.manifest(KubeScaleProps props)
Renders a Kubernetes manifest for “io.k8s.api.autoscaling.v1.Scale”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeScaleProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.Scale”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.autoscaling.v1.Scale”.
KubeSecret ¶
Secret holds secret data of a certain type.
The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeSecret;
KubeSecret.Builder.create(Construct scope, java.lang.String id)
// .data(java.util.Map<java.lang.String, java.lang.String>)
// .immutable(java.lang.Boolean)
// .metadata(ObjectMeta)
// .stringData(java.util.Map<java.lang.String, java.lang.String>)
// .type(java.lang.String)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
data |
java.util.Map |
Data contains the secret data. |
immutable |
java.lang.Boolean |
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
stringData |
java.util.Map |
stringData allows specifying non-binary secret data in string form. |
type |
java.lang.String |
Used to facilitate programmatic handling of secret data. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
dataOptional ¶
- Type: java.util.Map
Data contains the secret data.
Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
immutableOptional ¶
- Type: java.lang.Boolean
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).
If not set to true, the field can be modified at any time. Defaulted to nil.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
stringDataOptional ¶
- Type: java.util.Map
stringData allows specifying non-binary secret data in string form.
It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
typeOptional ¶
- Type: java.lang.String
Used to facilitate programmatic handling of secret data.
More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Secret”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeSecret;
KubeSecret.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeSecret;
KubeSecret.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeSecret;
KubeSecret.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeSecret;
KubeSecret.manifest(),KubeSecret.manifest(KubeSecretProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Secret”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeSecretProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Secret”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Secret”.
KubeSecretList ¶
SecretList is a list of Secret.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeSecretList;
KubeSecretList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeSecretProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
Items is a list of secret objects. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
Items is a list of secret objects.
More info: https://kubernetes.io/docs/concepts/configuration/secret
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.SecretList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeSecretList;
KubeSecretList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeSecretList;
KubeSecretList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeSecretList;
KubeSecretList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeSecretList;
KubeSecretList.manifest(KubeSecretListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.SecretList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeSecretListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.SecretList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.SecretList”.
KubeSelfSubjectAccessReview ¶
SelfSubjectAccessReview checks whether or the current user can perform an action.
Not filling in a spec.namespace means “in all namespaces”. Self is a special case, because users should always be able to check whether they can perform an action
Initializers ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReview;
KubeSelfSubjectAccessReview.Builder.create(Construct scope, java.lang.String id)
.spec(SelfSubjectAccessReviewSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.SelfSubjectAccessReviewSpec |
spec holds information about the request being evaluated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.SelfSubjectAccessReviewSpec
spec holds information about the request being evaluated.
user and groups must be empty
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReview;
KubeSelfSubjectAccessReview.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReview;
KubeSelfSubjectAccessReview.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReview;
KubeSelfSubjectAccessReview.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReview;
KubeSelfSubjectAccessReview.manifest(KubeSelfSubjectAccessReviewProps props)
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeSelfSubjectAccessReviewProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectAccessReview”.
KubeSelfSubjectReview ¶
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request.
When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectReview;
KubeSelfSubjectReview.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.SelfSubjectReview”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectReview;
KubeSelfSubjectReview.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectReview;
KubeSelfSubjectReview.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectReview;
KubeSelfSubjectReview.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectReview;
KubeSelfSubjectReview.manifest(),KubeSelfSubjectReview.manifest(KubeSelfSubjectReviewProps props)
Renders a Kubernetes manifest for “io.k8s.api.authentication.v1.SelfSubjectReview”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeSelfSubjectReviewProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.authentication.v1.SelfSubjectReview”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.authentication.v1.SelfSubjectReview”.
KubeSelfSubjectRulesReview ¶
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace.
The returned list of actions may be incomplete depending on the server’s authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReview;
KubeSelfSubjectRulesReview.Builder.create(Construct scope, java.lang.String id)
.spec(SelfSubjectRulesReviewSpec)
// .metadata(ObjectMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
spec |
org.cdk8s.plus36.k8s.SelfSubjectRulesReviewSpec |
spec holds information about the request being evaluated. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
metadata is the standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
specRequired ¶
- Type: org.cdk8s.plus36.k8s.SelfSubjectRulesReviewSpec
spec holds information about the request being evaluated.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
metadata is the standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReview;
KubeSelfSubjectRulesReview.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReview;
KubeSelfSubjectRulesReview.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReview;
KubeSelfSubjectRulesReview.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReview;
KubeSelfSubjectRulesReview.manifest(KubeSelfSubjectRulesReviewProps props)
Renders a Kubernetes manifest for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeSelfSubjectRulesReviewProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.authorization.v1.SelfSubjectRulesReview”.
KubeService ¶
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeService;
KubeService.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ServiceSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.ServiceSpec |
Spec defines the behavior of a service. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ServiceSpec
Spec defines the behavior of a service.
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Service”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeService;
KubeService.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeService;
KubeService.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeService;
KubeService.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeService;
KubeService.manifest(),KubeService.manifest(KubeServiceProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.Service”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.Service”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.Service”.
KubeServiceAccount ¶
ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceAccount;
KubeServiceAccount.Builder.create(Construct scope, java.lang.String id)
// .automountServiceAccountToken(java.lang.Boolean)
// .imagePullSecrets(java.util.List<LocalObjectReference>)
// .metadata(ObjectMeta)
// .secrets(java.util.List<ObjectReference>)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
automountServiceAccountToken |
java.lang.Boolean |
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. |
imagePullSecrets |
java.util.List |
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
secrets |
java.util.List |
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
automountServiceAccountTokenOptional ¶
- Type: java.lang.Boolean
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.
Can be overridden at the pod level.
imagePullSecretsOptional ¶
- Type: java.util.List
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount.
ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
secretsOptional ¶
- Type: java.util.List
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use.
Pods are only limited to this list if this service account has a “kubernetes.io/enforce-mountable-secrets” annotation set to “true”. The “kubernetes.io/enforce-mountable-secrets” annotation is deprecated since v1.32. Prefer separate namespaces to isolate access to mounted secrets. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccount”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeServiceAccount;
KubeServiceAccount.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeServiceAccount;
KubeServiceAccount.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeServiceAccount;
KubeServiceAccount.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeServiceAccount;
KubeServiceAccount.manifest(),KubeServiceAccount.manifest(KubeServiceAccountProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccount”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceAccountProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccount”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccount”.
KubeServiceAccountList ¶
ServiceAccountList is a list of ServiceAccount objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceAccountList;
KubeServiceAccountList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeServiceAccountProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
List of ServiceAccounts. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard list metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
List of ServiceAccounts.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccountList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeServiceAccountList;
KubeServiceAccountList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeServiceAccountList;
KubeServiceAccountList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeServiceAccountList;
KubeServiceAccountList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeServiceAccountList;
KubeServiceAccountList.manifest(KubeServiceAccountListProps props)
Renders a Kubernetes manifest for “io.k8s.api.core.v1.ServiceAccountList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceAccountListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccountList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.core.v1.ServiceAccountList”.
KubeServiceCidr ¶
ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceCidr;
KubeServiceCidr.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ServiceCidrSpec)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.ServiceCidrSpec |
spec is the desired state of the ServiceCIDR. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ServiceCidrSpec
spec is the desired state of the ServiceCIDR.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDR”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeServiceCidr;
KubeServiceCidr.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeServiceCidr;
KubeServiceCidr.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeServiceCidr;
KubeServiceCidr.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeServiceCidr;
KubeServiceCidr.manifest(),KubeServiceCidr.manifest(KubeServiceCidrProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDR”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsOptional ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceCidrProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDR”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDR”.
KubeServiceCidrList ¶
ServiceCIDRList contains a list of ServiceCIDR objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrList;
KubeServiceCidrList.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeServiceCidrProps>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of ServiceCIDRs. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of ServiceCIDRs.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDRList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrList;
KubeServiceCidrList.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrList;
KubeServiceCidrList.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrList;
KubeServiceCidrList.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrList;
KubeServiceCidrList.manifest(KubeServiceCidrListProps props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1.ServiceCIDRList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceCidrListProps
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDRList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1.ServiceCIDRList”.
KubeServiceCidrListV1Beta1 ¶
ServiceCIDRList contains a list of ServiceCIDR objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1;
KubeServiceCidrListV1Beta1.Builder.create(Construct scope, java.lang.String id)
.items(java.util.List<KubeServiceCidrv1Beta1Props>)
// .metadata(ListMeta)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
items |
java.util.List |
items is the list of ServiceCIDRs. |
metadata |
org.cdk8s.plus36.k8s.ListMeta |
Standard object’s metadata. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
itemsRequired ¶
- Type: java.util.List
items is the list of ServiceCIDRs.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ListMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
opsRequired ¶
- Type: org.cdk8s.JsonPatch…
The JSON-Patch operations to apply.
toJson ¶
public java.lang.Object toJson()
Renders the object to Kubernetes JSON.
Static Functions ¶
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isApiObject |
Return whether the given object is an ApiObject. |
of |
Returns the ApiObject named Resource which is a child of the given construct. |
manifest |
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDRList”. |
isConstruct ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1;
KubeServiceCidrListV1Beta1.isConstruct(java.lang.Object x)
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.
xRequired ¶
- Type: java.lang.Object
Any object.
isApiObject ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1;
KubeServiceCidrListV1Beta1.isApiObject(java.lang.Object o)
Return whether the given object is an ApiObject.
We do attribute detection since we can’t reliably use ‘instanceof’.
oRequired ¶
- Type: java.lang.Object
The object to check.
of ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1;
KubeServiceCidrListV1Beta1.of(IConstruct c)
Returns the ApiObject named Resource which is a child of the given construct.
If c is an ApiObject, it is returned directly. Throws an
exception if the construct does not have a child named Default or if
this child is not an ApiObject.
cRequired ¶
- Type: software.constructs.IConstruct
The higher-level construct.
manifest ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1;
KubeServiceCidrListV1Beta1.manifest(KubeServiceCidrListV1Beta1Props props)
Renders a Kubernetes manifest for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.
This can be used to inline resource manifests inside other objects (e.g. as templates).
propsRequired ¶
- Type: org.cdk8s.plus36.k8s.KubeServiceCidrListV1Beta1Props
initialization props.
Properties ¶
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
apiGroup |
java.lang.String |
The group portion of the API version (e.g. authorization.k8s.io). |
apiVersion |
java.lang.String |
The object’s API version (e.g. authorization.k8s.io/v1). |
chart |
org.cdk8s.Chart |
The chart in which this object is defined. |
kind |
java.lang.String |
The object kind. |
metadata |
org.cdk8s.ApiObjectMetadataDefinition |
Metadata associated with this API object. |
name |
java.lang.String |
The name of the API object. |
nodeRequired ¶
public Node getNode();
- Type: software.constructs.Node
The tree node.
apiGroupRequired ¶
public java.lang.String getApiGroup();
- Type: java.lang.String
The group portion of the API version (e.g. authorization.k8s.io).
apiVersionRequired ¶
public java.lang.String getApiVersion();
- Type: java.lang.String
The object’s API version (e.g. authorization.k8s.io/v1).
chartRequired ¶
public Chart getChart();
- Type: org.cdk8s.Chart
The chart in which this object is defined.
kindRequired ¶
public java.lang.String getKind();
- Type: java.lang.String
The object kind.
metadataRequired ¶
public ApiObjectMetadataDefinition getMetadata();
- Type: org.cdk8s.ApiObjectMetadataDefinition
Metadata associated with this API object.
nameRequired ¶
public java.lang.String getName();
- Type: java.lang.String
The name of the API object.
If a name is specified in metadata.name this will be the name returned.
Otherwise, a name will be generated by calling
Chart.of(this).generatedObjectName(this), which by default uses the
construct path to generate a DNS-compatible name for the resource.
Constants ¶
| Name | Type | Description |
|---|---|---|
GVK |
org.cdk8s.GroupVersionKind |
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDRList”. |
GVKRequired ¶
public GroupVersionKind getGvk();
- Type: org.cdk8s.GroupVersionKind
Returns the apiVersion and kind for “io.k8s.api.networking.v1beta1.ServiceCIDRList”.
KubeServiceCidrv1Beta1 ¶
ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.
Initializers ¶
import org.cdk8s.plus36.k8s.KubeServiceCidrv1Beta1;
KubeServiceCidrv1Beta1.Builder.create(Construct scope, java.lang.String id)
// .metadata(ObjectMeta)
// .spec(ServiceCidrSpecV1Beta1)
.build();
| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
the scope in which to define this object. |
id |
java.lang.String |
a scope-local name for the object. |
metadata |
org.cdk8s.plus36.k8s.ObjectMeta |
Standard object’s metadata. |
spec |
org.cdk8s.plus36.k8s.ServiceCidrSpecV1Beta1 |
spec is the desired state of the ServiceCIDR. |
scopeRequired ¶
- Type: software.constructs.Construct
the scope in which to define this object.
idRequired ¶
- Type: java.lang.String
a scope-local name for the object.
metadataOptional ¶
- Type: org.cdk8s.plus36.k8s.ObjectMeta
Standard object’s metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specOptional ¶
- Type: org.cdk8s.plus36.k8s.ServiceCidrSpecV1Beta1
spec is the desired state of the ServiceCIDR.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Methods ¶
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to this construct. |
addDependency |
Create a dependency between this ApiObject and other constructs. |
addJsonPatch |
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. |
toJson |
Renders the object to Kubernetes JSON. |
toString ¶
public java.lang.String toString()
Returns a string representation of this construct.
with ¶
public IConstruct with(IMixin... mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
mixinsRequired ¶
- Type: software.constructs.IMixin…
The mixins to apply.
addDependency ¶
public void addDependency(IConstruct... dependencies)
Create a dependency between this ApiObject and other constructs.
These can be other ApiObjects, Charts, or custom.
dependenciesRequired ¶
- Type: software.constructs.IConstruct…
the dependencies to add.
addJsonPatch ¶
public void addJsonPatch(JsonPatch... ops)
Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
Example
kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));