aws-cdk-lib.UniqueResourceNameOptions

UniqueResourceNameOptions Struct

Options for creating a unique resource name.

Source

core/lib/names.ts

Type last changed

v2.29.0 · 23 Jun 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const uniqueResourceNameOptions: cdk.UniqueResourceNameOptions = {
  allowedSpecialCharacters: 'allowedSpecialCharacters',
  maxLength: 123,
  separator: 'separator',
};

Properties

allowedSpecialCharactersstringallowed_special_charactersstrallowedSpecialCharactersStringAllowedSpecialCharactersstringAllowedSpecialCharacters*string= none#

Non-alphanumeric characters allowed in the unique resource name.

maxLengthnumbermax_lengthint | floatmaxLengthNumberMaxLengthdoubleMaxLength*float64= 256#

The maximum length of the unique resource name.

separatorstringseparatorstrseparatorStringSeparatorstringSeparator*string= none#

The separator used between the path components.