Class Control

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the control.

        Returns:
        The Amazon Resource Name (ARN) of the control.
      • id

        public final String id()

        The unique identifier for the control.

        Returns:
        The unique identifier for the control.
      • type

        public final ControlType type()

        Specifies whether the control is a standard control or a custom control.

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

        Returns:
        Specifies whether the control is a standard control or a custom control.
        See Also:
        ControlType
      • typeAsString

        public final String typeAsString()

        Specifies whether the control is a standard control or a custom control.

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

        Returns:
        Specifies whether the control is a standard control or a custom control.
        See Also:
        ControlType
      • name

        public final String name()

        The name of the control.

        Returns:
        The name of the control.
      • description

        public final String description()

        The description of the control.

        Returns:
        The description of the control.
      • testingInformation

        public final String testingInformation()

        The steps that you should follow to determine if the control has been satisfied.

        Returns:
        The steps that you should follow to determine if the control has been satisfied.
      • actionPlanTitle

        public final String actionPlanTitle()

        The title of the action plan for remediating the control.

        Returns:
        The title of the action plan for remediating the control.
      • actionPlanInstructions

        public final String actionPlanInstructions()

        The recommended actions to carry out if the control isn't fulfilled.

        Returns:
        The recommended actions to carry out if the control isn't fulfilled.
      • controlSources

        public final String controlSources()

        The data source types that determine where Audit Manager collects evidence from for the control.

        Returns:
        The data source types that determine where Audit Manager collects evidence from for the control.
      • hasControlMappingSources

        public final boolean hasControlMappingSources()
        For responses, this returns true if the service returned a value for the ControlMappingSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • controlMappingSources

        public final List<ControlMappingSource> controlMappingSources()

        The data mapping sources for the control.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasControlMappingSources() method.

        Returns:
        The data mapping sources for the control.
      • createdAt

        public final Instant createdAt()

        The time when the control was created.

        Returns:
        The time when the control was created.
      • lastUpdatedAt

        public final Instant lastUpdatedAt()

        The time when the control was most recently updated.

        Returns:
        The time when the control was most recently updated.
      • createdBy

        public final String createdBy()

        The user or role that created the control.

        Returns:
        The user or role that created the control.
      • lastUpdatedBy

        public final String lastUpdatedBy()

        The user or role that most recently updated the control.

        Returns:
        The user or role that most recently updated the control.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()

        The tags associated with the control.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags associated with the control.
      • state

        public final ControlState state()

        The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.

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

        Returns:
        The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.
        See Also:
        ControlState
      • stateAsString

        public final String stateAsString()

        The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.

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

        Returns:
        The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.
        See Also:
        ControlState
      • serializableBuilderClass

        public static Class<? extends Control.Builder> serializableBuilderClass()
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)