Class ParameterDefinition

java.lang.Object
software.amazon.awssdk.services.iam.model.ParameterDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>
@Generated("software.amazon.awssdk:codegen") public final class ParameterDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>

Defines a parameter that a role template accepts. You supply values for these parameters when you create a role with AcquireRole.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the parameter.

      Returns:
      The name of the parameter.

    • type

      public final ParameterTypeType type()

      The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.

      If the service returns an enum value that is not available in the current SDK version, type will return ParameterTypeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.
      See Also:

    • typeAsString

      public final String typeAsString()

      The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.

      If the service returns an enum value that is not available in the current SDK version, type will return ParameterTypeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.
      See Also:

    • subType

      public final String subType()

      An optional subtype that further constrains the values that are allowed for the parameter.

      Returns:
      An optional subtype that further constrains the values that are allowed for the parameter.

    • description

      public final String description()

      A description of the parameter.

      Returns:
      A description of the parameter.

    • isRequired

      public final Boolean isRequired()

      Specifies whether you must supply a value for the parameter when you create a role from the template.

      Returns:
      Specifies whether you must supply a value for the parameter when you create a role from the template.

    • defaultValue

      public final String defaultValue()

      The value that the service uses for the parameter when you do not supply one.

      Returns:
      The value that the service uses for the parameter when you do not supply one.

    • immutable

      public final Boolean immutable()

      Specifies whether you can change the parameter value after you create the role.

      Returns:
      Specifies whether you can change the parameter value after you create the role.

    • toBuilder

      public ParameterDefinition.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParameterDefinition.Builder,ParameterDefinition>
      Returns:
      a builder for type T

    • builder

      public static ParameterDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParameterDefinition.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.