org.cdk8s

Interface ApiObjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiObjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.40.0 (build 9713b9d)",
           date="2021-10-24T01:23:29.128Z")
 @Stability(value=Stable)
public interface ApiObjectProps
extends software.amazon.jsii.JsiiSerializable

Options for defining API objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiObjectProps.Builder A builder for ApiObjectProps
static class	ApiObjectProps.Jsii$Proxy An implementation for ApiObjectProps

Method Summary

Modifier and Type	Method and Description
static ApiObjectProps.Builder	builder()
String	getApiVersion() API version.
String	getKind() Resource kind.
default ApiObjectMetadata	getMetadata() Object metadata.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiVersion

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

API version.

getKind

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

Resource kind.

getMetadata

@Stability(value=Stable)
 @Nullable
default ApiObjectMetadata getMetadata()

Object metadata.

If name is not specified, an app-unique name will be allocated by the framework based on the path of the construct within thes construct tree.

builder

@Stability(value=Stable)
static ApiObjectProps.Builder builder()

Returns:

a ApiObjectProps.Builder of ApiObjectProps