GradientEdge CDK Utils
    Preparing search index...
    interface SSMStringParameterProps {
        allowedPattern?: string;
        dataType?: ParameterDataType;
        description?: string;
        parameterName?: string;
        simpleName?: boolean;
        stringValue: string;
        tier?: ParameterTier;
        type?: ParameterType;
    }

    Hierarchy

    • StringParameterProps
      • SSMStringParameterProps
    Index

    Properties

    allowedPattern?: string

    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ^\d+$

    no validation is performed
    
    dataType?: ParameterDataType

    The data type of the parameter, such as text or aws:ec2:image.

    ParameterDataType.TEXT
    
    description?: string

    Information about the parameter that you want to add to the system.

    none
    
    parameterName?: string

    The name of the parameter.

    - a name will be generated by CloudFormation
    
    simpleName?: boolean

    Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN.

    This is required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

    If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

    • auto-detect based on parameterName
    stringValue: string

    The value of the parameter. It may not reference another parameter and {{}} cannot be used in the value.

    tier?: ParameterTier

    The tier of the string parameter

    - undefined
    
    type?: ParameterType

    The type of the string parameter

    ParameterType.STRING
    
    • type will always be 'String'