Package software.amazon.awscdk.services.ssm

Class StringParameterAttributes.Jsii$Proxy

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

  • 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(StringParameterAttributes.Builder builder)
      Constructor that initializes the object based on literal property values passed by the StringParameterAttributes.Builder.

  • Method Details

    • getForceDynamicReference

      public final Boolean getForceDynamicReference()
      Description copied from interface: StringParameterAttributes
      Use a dynamic reference as the representation in CloudFormation template level.

      By default, CDK tries to deduce an appropriate representation based on the parameter value (a CfnParameter or a dynamic reference). Use this flag to override the representation when it does not work.

      Default: false

      Specified by:
      getForceDynamicReference in interface StringParameterAttributes

    • getType

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

      Default: ParameterType.STRING

      Specified by:
      getType in interface StringParameterAttributes

    • getValueType

      public final ParameterValueType getValueType()
      Description copied from interface: StringParameterAttributes
      The type of the string parameter value.

      Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

      Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

      Default: ParameterValueType.STRING

      Specified by:
      getValueType in interface StringParameterAttributes
      See Also:

    • getVersion

      public final Number getVersion()
      Description copied from interface: StringParameterAttributes
      The version number of the value you wish to retrieve.

      Default: The latest version will be retrieved.

      Specified by:
      getVersion in interface StringParameterAttributes

    • getParameterName

      public final String getParameterName()
      Description copied from interface: CommonStringParameterAttributes
      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).

      Specified by:
      getParameterName in interface CommonStringParameterAttributes

    • getSimpleName

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

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