@guardian/cdk
    Preparing search index...

    Interface GuParameterProps

    interface GuParameterProps {
        allowedPattern?: string;
        allowedValues?: string[];
        constraintDescription?: string;
        default?: any;
        description?: string;
        fromSSM?: boolean;
        maxLength?: number;
        maxValue?: number;
        minLength?: number;
        minValue?: number;
        noEcho?: boolean;
        type?: string;
    }

    Hierarchy

    • CfnParameterProps
      • GuParameterProps
    Index

    Properties

    allowedPattern? allowedValues? constraintDescription? default? description? fromSSM? maxLength? maxValue? minLength? minValue? noEcho? type?

    Properties

    allowedPattern?: string

    A regular expression that represents the patterns to allow for String types.

    - No constraints on patterns allowed for parameter.
    allowedValues?: string[]

    An array containing the list of values allowed for the parameter.

    - No constraints on values allowed for parameter.
    constraintDescription?: string

    A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

    - No description with customized error message when user specifies invalid values.
    default?: any

    A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

    - No default value for parameter.
    description?: string

    A string of up to 4000 characters that describes the parameter.

    - No description for the parameter.
    fromSSM?: boolean
    maxLength?: number

    An integer value that determines the largest number of characters you want to allow for String types.

    - None.
    maxValue?: number

    A numeric value that determines the largest numeric value you want to allow for Number types.

    - None.
    minLength?: number

    An integer value that determines the smallest number of characters you want to allow for String types.

    - None.
    minValue?: number

    A numeric value that determines the smallest numeric value you want to allow for Number types.

    - None.
    noEcho?: boolean

    Whether to mask the parameter value when anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

    - Parameter values are not masked.
    type?: string

    The data type for the parameter (DataType).

    String

    Settings

    Member Visibility

    On This Page

    Properties