Package software.amazon.awscdk

Interface UniqueResourceNameOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UniqueResourceNameOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.108Z")
@Stability(Stable)
public interface UniqueResourceNameOptions
extends software.amazon.jsii.JsiiSerializable

Options for creating a unique resource name.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 UniqueResourceNameOptions uniqueResourceNameOptions = UniqueResourceNameOptions.builder()
         .allowedSpecialCharacters("allowedSpecialCharacters")
         .maxLength(123)
         .separator("separator")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UniqueResourceNameOptions.Builder	builder()
default String	getAllowedSpecialCharacters()	Non-alphanumeric characters allowed in the unique resource name.
default Number	getMaxLength()	The maximum length of the unique resource name.
default String	getSeparator()	The separator used between the path components.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedSpecialCharacters

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

Non-alphanumeric characters allowed in the unique resource name.

Default: - none

getMaxLength

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

The maximum length of the unique resource name.

Default: - 256

getSeparator

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

The separator used between the path components.

Default: - none

builder

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

Returns:

a UniqueResourceNameOptions.Builder of UniqueResourceNameOptions