Package software.amazon.awscdk.services.ssm

Class StringParameterProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ssm.StringParameterProps.Jsii$Proxy
All Implemented Interfaces:
ParameterOptions, StringParameterProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
StringParameterProps
@Stability(Stable) @Internal public static final class StringParameterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements StringParameterProps
An implementation for StringParameterProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(StringParameterProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the StringParameterProps.Builder.

  • Method Details

    • getStringValue

      public final String getStringValue()
      Description copied from interface: StringParameterProps
      The value of the parameter.

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

      Specified by:
      getStringValue in interface StringParameterProps

    • getDataType

      public final ParameterDataType getDataType()
      Description copied from interface: StringParameterProps
      The data type of the parameter, such as text or aws:ec2:image.

      Default: ParameterDataType.TEXT

      Specified by:
      getDataType in interface StringParameterProps

    • getType

      public final ParameterType getType()
      Description copied from interface: StringParameterProps
      (deprecated) The type of the string parameter.

      Default: ParameterType.STRING

      Specified by:
      getType in interface StringParameterProps

    • getAllowedPattern

      public final String getAllowedPattern()
      Description copied from interface: ParameterOptions
      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

      Specified by:
      getAllowedPattern in interface ParameterOptions

    • getDescription

      public final String getDescription()
      Description copied from interface: ParameterOptions
      Information about the parameter that you want to add to the system.

      Default: none

      Specified by:
      getDescription in interface ParameterOptions

    • getParameterName

      public final String getParameterName()
      Description copied from interface: ParameterOptions
      The name of the parameter.

      Default: - a name will be generated by CloudFormation

      Specified by:
      getParameterName in interface ParameterOptions

    • getSimpleName

      public final Boolean getSimpleName()
      Description copied from interface: ParameterOptions
      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`

      Specified by:
      getSimpleName in interface ParameterOptions

    • getTier

      public final ParameterTier getTier()
      Description copied from interface: ParameterOptions
      The tier of the string parameter.

      Default: - undefined

      Specified by:
      getTier in interface ParameterOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object