Interface ParameterOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
StringListParameterProps, StringParameterProps
All Known Implementing Classes:
ParameterOptions.Jsii$Proxy, StringListParameterProps.Jsii$Proxy, StringParameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:24.165Z") @Stability(Stable) public interface ParameterOptions extends software.amazon.jsii.JsiiSerializable
Properties needed to create a new SSM Parameter.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 ParameterOptions parameterOptions = ParameterOptions.builder()
         .allowedPattern("allowedPattern")
         .description("description")
         .parameterName("parameterName")
         .simpleName(false)
         .tier(ParameterTier.ADVANCED)
         .build();
 
  • 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 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.

      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()
      Returns:
      a ParameterOptions.Builder of ParameterOptions