Package org.cdk8s

Interface NameOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NameOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-01-13T16:06:13.579Z")
@Stability(Stable)
public interface NameOptions
extends software.amazon.jsii.JsiiSerializable

Options for name generation.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NameOptions.Builder	builder()
default String	getDelimiter()	Delimiter to use between components.
default List<String>	getExtra()	Extra components to include in the name.
default Boolean	getIncludeHash()	Include a short hash as last part of the name.
default Number	getMaxLen()	Maximum allowed length for the name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDelimiter

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

Delimiter to use between components.

Default: "-"

getExtra

@Stability(Stable)
@Nullable
default List<String> getExtra()

Extra components to include in the name.

Default: [] use the construct path components

getIncludeHash

@Stability(Stable)
@Nullable
default Boolean getIncludeHash()

Include a short hash as last part of the name.

Default: true

getMaxLen

@Stability(Stable)
@Nullable
default Number getMaxLen()

Maximum allowed length for the name.

Default: 63

builder

@Stability(Stable)
static NameOptions.Builder builder()

Returns:

a NameOptions.Builder of NameOptions