Package org.cdk8s.plus24

Interface IApiResource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApiResource.Jsii$Default

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-09T03:04:24.870Z")
@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.