Interface PolicyMask

All Known Implementing Classes:
PolicyMaskJson
public interface PolicyMask
A policy mask that constrains the managed policies and permission sets available to a principal, as returned by the IAM policy-mask operations.

This is a read-only response view (spec schema PolicyMask). The managedPolicies/managedPermissionSets fields are a oneOf of the literal string "none" or an array of ids, and subtract is a structured object; all three are exposed as lossless PolicyExpression values preserving whichever form was returned.

  • Method Details

    • getPolicyMaskId

      String getPolicyMaskId()
      Returns:
      the policy mask identifier

    • getErn

      String getErn()
      Returns:
      the Equinix Resource Name (ERN) of the policy mask

    • getDescription

      String getDescription()
      Returns:
      the description of the policy mask (may be null)

    • getTags

      Map<String,String> getTags()
      Returns:
      the user-controlled tags on the policy mask

    • getManagedPolicies

      PolicyExpression getManagedPolicies()
      Returns:
      the managed policies as a lossless PolicyExpression - either the string "none" or an array of managedpolicy: ids

    • getManagedPermissionSets

      PolicyExpression getManagedPermissionSets()
      Returns:
      the managed permission sets as a lossless PolicyExpression - either the string "none" or an array of managedset: ids

    • getSubtract

      PolicyExpression getSubtract()
      Returns:
      the subtract object as a lossless PolicyExpression (carrying nested managedPolicies/managedPermissionSets arrays), or null

    • getRev

      String getRev()
      Returns:
      the opaque revision of the policy mask (used as lastRev)

    • getDisabledPolicy

      Boolean getDisabledPolicy()
      Returns:
      true when the policy mask is disabled, otherwise null

    • getCreatedBy

      String getCreatedBy()
      Returns:
      the principal that created the policy mask

    • getCreatedAt

      String getCreatedAt()
      Returns:
      the creation timestamp

    • getUpdatedBy

      String getUpdatedBy()
      Returns:
      the principal that last updated the policy mask

    • getUpdatedAt

      String getUpdatedAt()
      Returns:
      the last-updated timestamp