Interface Annotation.Builder

    • Method Detail

      • annotationName

        Annotation.Builder annotationName​(String annotationName)

        An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

        Parameters:
        annotationName - An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        Annotation.Builder status​(String status)

        The status of the Hook invocation from the downstream service.

        Parameters:
        status - The status of the Hook invocation from the downstream service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnnotationStatus, AnnotationStatus
      • status

        Annotation.Builder status​(AnnotationStatus status)

        The status of the Hook invocation from the downstream service.

        Parameters:
        status - The status of the Hook invocation from the downstream service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnnotationStatus, AnnotationStatus
      • statusMessage

        Annotation.Builder statusMessage​(String statusMessage)

        The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".

        Parameters:
        statusMessage - The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • remediationMessage

        Annotation.Builder remediationMessage​(String remediationMessage)

        Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

        Parameters:
        remediationMessage - Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • remediationLink

        Annotation.Builder remediationLink​(String remediationLink)

        A URL that you can access for additional remediation guidance.

        Parameters:
        remediationLink - A URL that you can access for additional remediation guidance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • severityLevel

        Annotation.Builder severityLevel​(String severityLevel)

        The relative risk associated with any violations of this type.

        Parameters:
        severityLevel - The relative risk associated with any violations of this type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnnotationSeverityLevel, AnnotationSeverityLevel