org.cdk8s

Class ApiObject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.ApiObject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-13T17:18:47.420Z")
 @Stability(value=Stable)
public class ApiObject
extends software.constructs.Construct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiObject.Builder A fluent builder for ApiObject.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ApiObject(software.constructs.Construct scope, String id, ApiObjectProps props) Defines an API object.
protected	ApiObject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiObject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addDependency(software.constructs.IConstruct... dependencies) Create a dependency between this ApiObject and other constructs.
void	addJsonPatch(JsonPatch... ops) Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
String	getApiGroup() The group portion of the API version (e.g.
String	getApiVersion() The object's API version (e.g.
Chart	getChart() The chart in which this object is defined.
String	getKind() The object kind.
ApiObjectMetadataDefinition	getMetadata() Metadata associated with this API object.
String	getName() The name of the API object.
static ApiObject	of(software.constructs.IConstruct c) Returns the `ApiObject` named `Resource` which is a child of the given construct.
Object	toJson() Renders the object to Kubernetes JSON.

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, onValidate, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ApiObject

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

ApiObject

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

ApiObject

@Stability(value=Stable)
public ApiObject(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          ApiObjectProps props)

Defines an API object.

Parameters:

scope - the construct scope. This parameter is required.

id - namespace. This parameter is required.

props - options. This parameter is required.

Method Detail

of

@Stability(value=Stable)
 @NotNull
public static ApiObject of(@NotNull
                                                              software.constructs.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.

Parameters:

c - The higher-level construct. This parameter is required.

addDependency

@Stability(value=Stable)
public void addDependency(@NotNull
                                                   software.constructs.IConstruct... dependencies)

Create a dependency between this ApiObject and other constructs.

These can be other ApiObjects, Charts, or custom.

Parameters:

dependencies - the dependencies to add. This parameter is required.

addJsonPatch

@Stability(value=Stable)
public void addJsonPatch(@NotNull
                                                  JsonPatch... ops)

Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 kubePod.addJsonPatch(JsonPatch.replace("/spec/enableServiceLinks", true));

Parameters:

ops - The JSON-Patch operations to apply. This parameter is required.

toJson

@Stability(value=Stable)
 @NotNull
public Object toJson()

Renders the object to Kubernetes JSON.

To disable sorting of dictionary keys in output object set the CDK8S_DISABLE_SORT environment variable to any non-empty value.

getApiGroup

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

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

getApiVersion

@Stability(value=Stable)
 @NotNull
public String getApiVersion()

The object's API version (e.g. `authorization.k8s.io/v1`).

getChart

@Stability(value=Stable)
 @NotNull
public Chart getChart()

The chart in which this object is defined.

getKind

@Stability(value=Stable)
 @NotNull
public String getKind()

The object kind.

getMetadata

@Stability(value=Stable)
 @NotNull
public ApiObjectMetadataDefinition getMetadata()

Metadata associated with this API object.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

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.