Class PermissionTemplateParameterDeclaration

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

Describes a template parameter declaration for a customer managed permission. Each declaration defines a named placeholder that can be used in the permission's policy template.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the template parameter. This name is used as the placeholder in the policy template using the syntax @{parameterName}.

      Returns:
      The name of the template parameter. This name is used as the placeholder in the policy template using the syntax @{parameterName}.

    • type

      public final PermissionTemplateParameterType type()

      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value that is substituted directly into the template.

      • STRING_LIST – One or more string values that expand to an array in the rendered policy.

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

      Returns:
      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value that is substituted directly into the template.

      • STRING_LIST – One or more string values that expand to an array in the rendered policy.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value that is substituted directly into the template.

      • STRING_LIST – One or more string values that expand to an array in the rendered policy.

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

      Returns:
      The type of the template parameter. This can be one of the following values:

      • STRING – A single string value that is substituted directly into the template.

      • STRING_LIST – One or more string values that expand to an array in the rendered policy.

      See Also:

    • description

      public final String description()

      A description of the template parameter that helps consumers understand what value to provide.

      Returns:
      A description of the template parameter that helps consumers understand what value to provide.

    • toBuilder

      public PermissionTemplateParameterDeclaration.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<PermissionTemplateParameterDeclaration.Builder,PermissionTemplateParameterDeclaration>
      Returns:
      a builder for type T

    • builder

      public static PermissionTemplateParameterDeclaration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PermissionTemplateParameterDeclaration.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.