org.cdk8s

Class Names

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.Names

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-22T00:23:08.200Z")
 @Stability(value=Stable)
public class Names
extends software.amazon.jsii.JsiiObject

Utilities for generating unique and stable names.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static String	toDnsLabel(software.constructs.Construct scope) Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path.
static String	toDnsLabel(software.constructs.Construct scope, NameOptions options) Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path.
static String	toLabelValue(software.constructs.Construct scope) Generates a unique and stable name compatible label key name segment and label value from a path.
static String	toLabelValue(software.constructs.Construct scope, NameOptions options) Generates a unique and stable name compatible label key name segment and label value from a path.

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 software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Names

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

Names

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

Method Detail

toDnsLabel

@Stability(value=Stable)
 @NotNull
public static String toDnsLabel(@NotNull
                                                                   software.constructs.Construct scope,
                                                                   @Nullable
                                                                   NameOptions options)

Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path.

The generated name will:

• contain at most 63 characters
• contain only lowercase alphanumeric characters or ‘-’
• start with an alphanumeric character
• end with an alphanumeric character

The generated name will have the form: --..--

Where are the path components (assuming they are is separated by "/").

Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning.

Parameters:

scope - The construct for which to render the DNS label. This parameter is required.

options - Name options.

toDnsLabel

@Stability(value=Stable)
 @NotNull
public static String toDnsLabel(@NotNull
                                                                   software.constructs.Construct scope)

Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path.

The generated name will:

• contain at most 63 characters
• contain only lowercase alphanumeric characters or ‘-’
• start with an alphanumeric character
• end with an alphanumeric character

The generated name will have the form: --..--

Where are the path components (assuming they are is separated by "/").

Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning.

Parameters:

scope - The construct for which to render the DNS label. This parameter is required.

toLabelValue

@Stability(value=Stable)
 @NotNull
public static String toLabelValue(@NotNull
                                                                     software.constructs.Construct scope,
                                                                     @Nullable
                                                                     NameOptions options)

Generates a unique and stable name compatible label key name segment and label value from a path.

The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

Valid label values must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

The generated name will have the form: ..

Where are the path components (assuming they are is separated by "/").

Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning.

Parameters:

scope - The construct for which to render the DNS label. This parameter is required.

options - Name options.

toLabelValue

@Stability(value=Stable)
 @NotNull
public static String toLabelValue(@NotNull
                                                                     software.constructs.Construct scope)

Generates a unique and stable name compatible label key name segment and label value from a path.

The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

Valid label values must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

The generated name will have the form: ..

Where are the path components (assuming they are is separated by "/").

Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning.

Parameters:

scope - The construct for which to render the DNS label. This parameter is required.