Interface StringParameterProps

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:39.789Z") @Stability(Stable) public interface StringParameterProps extends software.amazon.jsii.JsiiSerializable, ParameterOptions
Properties needed to create a String SSM parameter.

Example:

 import software.amazon.awscdk.services.lambda.*;
 IFunction func;
 StringParameter simpleParameter = StringParameter.Builder.create(this, "StringParameter")
         // the parameter name doesn't contain any '/'
         .parameterName("parameter")
         .stringValue("SOME_VALUE")
         .simpleName(true)
         .build();
 StringParameter nonSimpleParameter = StringParameter.Builder.create(this, "StringParameter")
         // the parameter name contains '/'
         .parameterName(String.format("/%s/my/app/param", func.getFunctionName()))
         .stringValue("SOME_VALUE")
         .simpleName(false)
         .build();
 
  • Method Details

    • getStringValue

      @Stability(Stable) @NotNull String getStringValue()
      The value of the parameter.

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

    • getDataType

      @Stability(Stable) @Nullable default ParameterDataType getDataType()
      The data type of the parameter, such as text or aws:ec2:image.

      Default: ParameterDataType.TEXT

    • getType

      @Stability(Deprecated) @Deprecated @Nullable default ParameterType getType()
      Deprecated.
      • type will always be 'String'
      (deprecated) The type of the string parameter.

      Default: ParameterType.STRING

    • builder

      @Stability(Stable) static StringParameterProps.Builder builder()
      Returns:
      a StringParameterProps.Builder of StringParameterProps