Interface ParameterOptions

All Superinterfaces:
All Known Subinterfaces:
StringListParameterProps, StringParameterProps
All Known Implementing Classes:
ParameterOptions.Jsii$Proxy, StringListParameterProps.Jsii$Proxy, StringParameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.830Z") @Stability(Stable) public interface ParameterOptions extends
Properties needed to create a new SSM Parameter.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ParameterOptions parameterOptions = ParameterOptions.builder()
  • Method Details

    • getAllowedPattern

      @Stability(Stable) @Nullable default String getAllowedPattern()
      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+$

      Default: no validation is performed

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Information about the parameter that you want to add to the system.

      Default: none

    • getParameterName

      @Stability(Stable) @Nullable default String getParameterName()
      The name of the parameter.

      Default: - a name will be generated by CloudFormation

    • getSimpleName

      @Stability(Stable) @Nullable default Boolean getSimpleName()
      Indicates of the parameter name is a simple name (i.e. does not include "/" separators).

      This is only 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.

      Default: - auto-detect based on `parameterName`

    • getTier

      @Stability(Stable) @Nullable default ParameterTier getTier()
      The tier of the string parameter.

      Default: - undefined

    • builder

      @Stability(Stable) static ParameterOptions.Builder builder()
      a ParameterOptions.Builder of ParameterOptions