Package org.cdk8s.plus24

Class ApiResource

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.plus24.ApiResource

All Implemented Interfaces:

IApiEndpoint, IApiResource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
           date="2023-02-21T02:37:35.137Z")
@Stability(Stable)
public class ApiResource
extends software.amazon.jsii.JsiiObject
implements IApiResource, IApiEndpoint

Represents information about an API resource type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IApiEndpoint

IApiEndpoint.Jsii$Default, IApiEndpoint.Jsii$Proxy

Nested classes/interfaces inherited from interface org.cdk8s.plus24.IApiResource

IApiResource.Jsii$Default, IApiResource.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static ApiResource	API_SERVICES	API resource information for APIService.
static ApiResource	BINDINGS	API resource information for Binding.
static ApiResource	CERTIFICATE_SIGNING_REQUESTS	API resource information for CertificateSigningRequest.
static ApiResource	CLUSTER_ROLE_BINDINGS	API resource information for ClusterRoleBinding.
static ApiResource	CLUSTER_ROLES	API resource information for ClusterRole.
static ApiResource	COMPONENT_STATUSES	API resource information for ComponentStatus.
static ApiResource	CONFIG_MAPS	API resource information for ConfigMap.
static ApiResource	CONTROLLER_REVISIONS	API resource information for ControllerRevision.
static ApiResource	CRON_JOBS	API resource information for CronJob.
static ApiResource	CSI_DRIVERS	API resource information for CSIDriver.
static ApiResource	CSI_NODES	API resource information for CSINode.
static ApiResource	CSI_STORAGE_CAPACITIES	API resource information for CSIStorageCapacity.
static ApiResource	CUSTOM_RESOURCE_DEFINITIONS	API resource information for CustomResourceDefinition.
static ApiResource	DAEMON_SETS	API resource information for DaemonSet.
static ApiResource	DEPLOYMENTS	API resource information for Deployment.
static ApiResource	ENDPOINT_SLICES	API resource information for EndpointSlice.
static ApiResource	ENDPOINTS	API resource information for Endpoints.
static ApiResource	EVENTS	API resource information for Event.
static ApiResource	FLOW_SCHEMAS	API resource information for FlowSchema.
static ApiResource	HORIZONTAL_POD_AUTOSCALERS	API resource information for HorizontalPodAutoscaler.
static ApiResource	INGRESS_CLASSES	API resource information for IngressClass.
static ApiResource	INGRESSES	API resource information for Ingress.
static ApiResource	JOBS	API resource information for Job.
static ApiResource	LEASES	API resource information for Lease.
static ApiResource	LIMIT_RANGES	API resource information for LimitRange.
static ApiResource	LOCAL_SUBJECT_ACCESS_REVIEWS	API resource information for LocalSubjectAccessReview.
static ApiResource	MUTATING_WEBHOOK_CONFIGURATIONS	API resource information for MutatingWebhookConfiguration.
static ApiResource	NAMESPACES	API resource information for Namespace.
static ApiResource	NETWORK_POLICIES	API resource information for NetworkPolicy.
static ApiResource	NODES	API resource information for Node.
static ApiResource	PERSISTENT_VOLUME_CLAIMS	API resource information for PersistentVolumeClaim.
static ApiResource	PERSISTENT_VOLUMES	API resource information for PersistentVolume.
static ApiResource	POD_DISRUPTION_BUDGETS	API resource information for PodDisruptionBudget.
static ApiResource	POD_SECURITY_POLICIES	API resource information for PodSecurityPolicy.
static ApiResource	POD_TEMPLATES	API resource information for PodTemplate.
static ApiResource	PODS	API resource information for Pod.
static ApiResource	PRIORITY_CLASSES	API resource information for PriorityClass.
static ApiResource	PRIORITY_LEVEL_CONFIGURATIONS	API resource information for PriorityLevelConfiguration.
static ApiResource	REPLICA_SETS	API resource information for ReplicaSet.
static ApiResource	REPLICATION_CONTROLLERS	API resource information for ReplicationController.
static ApiResource	RESOURCE_QUOTAS	API resource information for ResourceQuota.
static ApiResource	ROLE_BINDINGS	API resource information for RoleBinding.
static ApiResource	ROLES	API resource information for Role.
static ApiResource	RUNTIME_CLASSES	API resource information for RuntimeClass.
static ApiResource	SECRETS	API resource information for Secret.
static ApiResource	SELF_SUBJECT_ACCESS_REVIEWS	API resource information for SelfSubjectAccessReview.
static ApiResource	SELF_SUBJECT_RULES_REVIEWS	API resource information for SelfSubjectRulesReview.
static ApiResource	SERVICE_ACCOUNTS	API resource information for ServiceAccount.
static ApiResource	SERVICES	API resource information for Service.
static ApiResource	STATEFUL_SETS	API resource information for StatefulSet.
static ApiResource	STORAGE_CLASSES	API resource information for StorageClass.
static ApiResource	SUBJECT_ACCESS_REVIEWS	API resource information for SubjectAccessReview.
static ApiResource	TOKEN_REVIEWS	API resource information for TokenReview.
static ApiResource	VALIDATING_WEBHOOK_CONFIGURATIONS	API resource information for ValidatingWebhookConfiguration.
static ApiResource	VOLUME_ATTACHMENTS	API resource information for VolumeAttachment.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ApiResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiResource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
IApiResource	asApiResource()	Return the IApiResource this object represents.
String	asNonApiResource()	Return the non resource url this object represents.
static ApiResource	custom(ApiResourceOptions options)	API resource information for a custom resource type.
String	getApiGroup()	The group portion of the API version (e.g.
String	getResourceType()	The name of the resource type as it appears in the relevant API endpoint.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cdk8s.plus24.IApiResource

getResourceName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

API_SERVICES

@Stability(Stable)
public static final ApiResource API_SERVICES

API resource information for APIService.

BINDINGS

@Stability(Stable)
public static final ApiResource BINDINGS

API resource information for Binding.

CERTIFICATE_SIGNING_REQUESTS

@Stability(Stable)
public static final ApiResource CERTIFICATE_SIGNING_REQUESTS

API resource information for CertificateSigningRequest.

CLUSTER_ROLE_BINDINGS

@Stability(Stable)
public static final ApiResource CLUSTER_ROLE_BINDINGS

API resource information for ClusterRoleBinding.

CLUSTER_ROLES

@Stability(Stable)
public static final ApiResource CLUSTER_ROLES

API resource information for ClusterRole.

COMPONENT_STATUSES

@Stability(Stable)
public static final ApiResource COMPONENT_STATUSES

API resource information for ComponentStatus.

CONFIG_MAPS

@Stability(Stable)
public static final ApiResource CONFIG_MAPS

API resource information for ConfigMap.

CONTROLLER_REVISIONS

@Stability(Stable)
public static final ApiResource CONTROLLER_REVISIONS

API resource information for ControllerRevision.

CRON_JOBS

@Stability(Stable)
public static final ApiResource CRON_JOBS

API resource information for CronJob.

CSI_DRIVERS

@Stability(Stable)
public static final ApiResource CSI_DRIVERS

API resource information for CSIDriver.

CSI_NODES

@Stability(Stable)
public static final ApiResource CSI_NODES

API resource information for CSINode.

CSI_STORAGE_CAPACITIES

@Stability(Stable)
public static final ApiResource CSI_STORAGE_CAPACITIES

API resource information for CSIStorageCapacity.

CUSTOM_RESOURCE_DEFINITIONS

@Stability(Stable)
public static final ApiResource CUSTOM_RESOURCE_DEFINITIONS

API resource information for CustomResourceDefinition.

DAEMON_SETS

@Stability(Stable)
public static final ApiResource DAEMON_SETS

API resource information for DaemonSet.

DEPLOYMENTS

@Stability(Stable)
public static final ApiResource DEPLOYMENTS

API resource information for Deployment.

ENDPOINT_SLICES

@Stability(Stable)
public static final ApiResource ENDPOINT_SLICES

API resource information for EndpointSlice.

ENDPOINTS

@Stability(Stable)
public static final ApiResource ENDPOINTS

API resource information for Endpoints.

EVENTS

@Stability(Stable)
public static final ApiResource EVENTS

API resource information for Event.

FLOW_SCHEMAS

@Stability(Stable)
public static final ApiResource FLOW_SCHEMAS

API resource information for FlowSchema.

HORIZONTAL_POD_AUTOSCALERS

@Stability(Stable)
public static final ApiResource HORIZONTAL_POD_AUTOSCALERS

API resource information for HorizontalPodAutoscaler.

INGRESS_CLASSES

@Stability(Stable)
public static final ApiResource INGRESS_CLASSES

API resource information for IngressClass.

INGRESSES

@Stability(Stable)
public static final ApiResource INGRESSES

API resource information for Ingress.

JOBS

@Stability(Stable)
public static final ApiResource JOBS

API resource information for Job.

LEASES

@Stability(Stable)
public static final ApiResource LEASES

API resource information for Lease.

LIMIT_RANGES

@Stability(Stable)
public static final ApiResource LIMIT_RANGES

API resource information for LimitRange.

LOCAL_SUBJECT_ACCESS_REVIEWS

@Stability(Stable)
public static final ApiResource LOCAL_SUBJECT_ACCESS_REVIEWS

API resource information for LocalSubjectAccessReview.

MUTATING_WEBHOOK_CONFIGURATIONS

@Stability(Stable)
public static final ApiResource MUTATING_WEBHOOK_CONFIGURATIONS

API resource information for MutatingWebhookConfiguration.

NAMESPACES

@Stability(Stable)
public static final ApiResource NAMESPACES

API resource information for Namespace.

NETWORK_POLICIES

@Stability(Stable)
public static final ApiResource NETWORK_POLICIES

API resource information for NetworkPolicy.

NODES

@Stability(Stable)
public static final ApiResource NODES

API resource information for Node.

PERSISTENT_VOLUME_CLAIMS

@Stability(Stable)
public static final ApiResource PERSISTENT_VOLUME_CLAIMS

API resource information for PersistentVolumeClaim.

PERSISTENT_VOLUMES

@Stability(Stable)
public static final ApiResource PERSISTENT_VOLUMES

API resource information for PersistentVolume.

POD_DISRUPTION_BUDGETS

@Stability(Stable)
public static final ApiResource POD_DISRUPTION_BUDGETS

API resource information for PodDisruptionBudget.

POD_SECURITY_POLICIES

@Stability(Stable)
public static final ApiResource POD_SECURITY_POLICIES

API resource information for PodSecurityPolicy.

POD_TEMPLATES

@Stability(Stable)
public static final ApiResource POD_TEMPLATES

API resource information for PodTemplate.

PODS

@Stability(Stable)
public static final ApiResource PODS

API resource information for Pod.

PRIORITY_CLASSES

@Stability(Stable)
public static final ApiResource PRIORITY_CLASSES

API resource information for PriorityClass.

PRIORITY_LEVEL_CONFIGURATIONS

@Stability(Stable)
public static final ApiResource PRIORITY_LEVEL_CONFIGURATIONS

API resource information for PriorityLevelConfiguration.

REPLICA_SETS

@Stability(Stable)
public static final ApiResource REPLICA_SETS

API resource information for ReplicaSet.

REPLICATION_CONTROLLERS

@Stability(Stable)
public static final ApiResource REPLICATION_CONTROLLERS

API resource information for ReplicationController.

RESOURCE_QUOTAS

@Stability(Stable)
public static final ApiResource RESOURCE_QUOTAS

API resource information for ResourceQuota.

ROLE_BINDINGS

@Stability(Stable)
public static final ApiResource ROLE_BINDINGS

API resource information for RoleBinding.

ROLES

@Stability(Stable)
public static final ApiResource ROLES

API resource information for Role.

RUNTIME_CLASSES

@Stability(Stable)
public static final ApiResource RUNTIME_CLASSES

API resource information for RuntimeClass.

SECRETS

@Stability(Stable)
public static final ApiResource SECRETS

API resource information for Secret.

SELF_SUBJECT_ACCESS_REVIEWS

@Stability(Stable)
public static final ApiResource SELF_SUBJECT_ACCESS_REVIEWS

API resource information for SelfSubjectAccessReview.

SELF_SUBJECT_RULES_REVIEWS

@Stability(Stable)
public static final ApiResource SELF_SUBJECT_RULES_REVIEWS

API resource information for SelfSubjectRulesReview.

SERVICE_ACCOUNTS

@Stability(Stable)
public static final ApiResource SERVICE_ACCOUNTS

API resource information for ServiceAccount.

SERVICES

@Stability(Stable)
public static final ApiResource SERVICES

API resource information for Service.

STATEFUL_SETS

@Stability(Stable)
public static final ApiResource STATEFUL_SETS

API resource information for StatefulSet.

STORAGE_CLASSES

@Stability(Stable)
public static final ApiResource STORAGE_CLASSES

API resource information for StorageClass.

SUBJECT_ACCESS_REVIEWS

@Stability(Stable)
public static final ApiResource SUBJECT_ACCESS_REVIEWS

API resource information for SubjectAccessReview.

TOKEN_REVIEWS

@Stability(Stable)
public static final ApiResource TOKEN_REVIEWS

API resource information for TokenReview.

VALIDATING_WEBHOOK_CONFIGURATIONS

@Stability(Stable)
public static final ApiResource VALIDATING_WEBHOOK_CONFIGURATIONS

API resource information for ValidatingWebhookConfiguration.

VOLUME_ATTACHMENTS

@Stability(Stable)
public static final ApiResource VOLUME_ATTACHMENTS

API resource information for VolumeAttachment.

Constructor Detail

ApiResource

protected ApiResource(software.amazon.jsii.JsiiObjectRef objRef)

ApiResource

protected ApiResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

custom

@Stability(Stable)
@NotNull
public static ApiResource custom(@NotNull
                                 ApiResourceOptions options)

API resource information for a custom resource type.

Parameters:

options - This parameter is required.

asApiResource

@Stability(Stable)
@Nullable
public IApiResource asApiResource()

Return the IApiResource this object represents.

Specified by:

asApiResource in interface IApiEndpoint

asNonApiResource

@Stability(Stable)
@Nullable
public String asNonApiResource()

Return the non resource url this object represents.

Specified by:

asNonApiResource in interface IApiEndpoint

getApiGroup

@Stability(Stable)
@NotNull
public String getApiGroup()

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

Specified by:

getApiGroup in interface IApiResource

getResourceType

@Stability(Stable)
@NotNull
public String getResourceType()

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

Example:

 - "pods" or "pods/log"
 

Specified by:

getResourceType in interface IApiResource

See Also:

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