Interface CommonStringParameterAttributes

All Superinterfaces:
All Known Subinterfaces:
SecureStringParameterAttributes, StringParameterAttributes
All Known Implementing Classes:
CommonStringParameterAttributes.Jsii$Proxy, SecureStringParameterAttributes.Jsii$Proxy, StringParameterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.824Z") @Stability(Stable) public interface CommonStringParameterAttributes extends
Common attributes for string parameters.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CommonStringParameterAttributes commonStringParameterAttributes = CommonStringParameterAttributes.builder()
         // the properties below are optional
  • Method Details

    • getParameterName

      @Stability(Stable) @NotNull String getParameterName()
      The name of the parameter store value.

      This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

    • 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`

    • builder

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