Package org.cdk8s.plus25

Interface IApiResource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApiResource.Jsii$Default, IClusterRole, IClusterRole.Jsii$Default, IConfigMap, IConfigMap.Jsii$Default, IPersistentVolume, IPersistentVolume.Jsii$Default, IPersistentVolumeClaim, IPersistentVolumeClaim.Jsii$Default, IResource, IResource.Jsii$Default, IRole, IRole.Jsii$Default, ISecret, ISecret.Jsii$Default, IServiceAccount, IServiceAccount.Jsii$Default

All Known Implementing Classes:

AbstractPod, ApiResource, AwsElasticBlockStorePersistentVolume, AzureDiskPersistentVolume, BasicAuthSecret, ClusterRole, ClusterRoleBinding, ConfigMap, CronJob, DaemonSet, Deployment, DockerConfigSecret, GCEPersistentDiskPersistentVolume, HorizontalPodAutoscaler, IApiResource.Jsii$Proxy, IClusterRole.Jsii$Proxy, IConfigMap.Jsii$Proxy, Ingress, IPersistentVolume.Jsii$Proxy, IPersistentVolumeClaim.Jsii$Proxy, IResource.Jsii$Proxy, IRole.Jsii$Proxy, ISecret.Jsii$Proxy, IServiceAccount.Jsii$Proxy, Job, Namespace, NetworkPolicy, PersistentVolume, PersistentVolumeClaim, Pod, Resource, Role, RoleBinding, Secret, Service, ServiceAccount, ServiceAccountTokenSecret, SshAuthSecret, StatefulSet, TlsSecret, Workload

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.296Z")
@Stability(Stable)
public interface IApiResource
extends software.amazon.jsii.JsiiSerializable

Represents a resource or collection of resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IApiResource.Jsii$Default	Internal default implementation for IApiResource.
static class	IApiResource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getApiGroup()	The group portion of the API version (e.g.
default String	getResourceName()	The unique, namespace-global, name of an object inside the Kubernetes cluster.
String	getResourceType()	The name of a resource type as it appears in the relevant API endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiGroup

@Stability(Stable)
@NotNull
String getApiGroup()

The group portion of the API version (e.g. authorization.k8s.io).

getResourceType

@Stability(Stable)
@NotNull
String getResourceType()

The name of a resource type as it appears in the relevant API endpoint.

Example:

 - "pods" or "pods/log"
 

See Also:

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources

getResourceName

@Stability(Stable)
@Nullable
default String getResourceName()

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.