Package software.amazon.awssdk.services.securityhub.model

Class SecurityControl

    • Method Detail

      • securityControlId

        public final String securityControlId()

        The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.

        Returns:
        The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.

      • securityControlArn

        public final String securityControlArn()

        The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

        Returns:
        The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

      • title

        public final String title()

        The title of a security control.

        Returns:
        The title of a security control.

      • description

        public final String description()

        The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

        Returns:
        The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

      • remediationUrl

        public final String remediationUrl()

        A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

        Returns:
        A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

      • securityControlStatus

        public final ControlStatus securityControlStatus()

        The enablement status of a security control in a specific standard.

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

        Returns:
        The enablement status of a security control in a specific standard.
        See Also:
        ControlStatus

      • securityControlStatusAsString

        public final String securityControlStatusAsString()

        The enablement status of a security control in a specific standard.

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

        Returns:
        The enablement status of a security control in a specific standard.
        See Also:
        ControlStatus

      • updateStatus

        public final UpdateStatus updateStatus()

        Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY indicates findings include the current parameter values. A status of UPDATING indicates that all findings may not include the current parameter values.

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

        Returns:
        Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY indicates findings include the current parameter values. A status of UPDATING indicates that all findings may not include the current parameter values.
        See Also:
        UpdateStatus

      • updateStatusAsString

        public final String updateStatusAsString()

        Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY indicates findings include the current parameter values. A status of UPDATING indicates that all findings may not include the current parameter values.

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

        Returns:
        Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY indicates findings include the current parameter values. A status of UPDATING indicates that all findings may not include the current parameter values.
        See Also:
        UpdateStatus

      • hasParameters

        public final boolean hasParameters()
        For responses, this returns true if the service returned a value for the Parameters 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.

      • parameters

        public final Map<String,​ParameterConfiguration> parameters()

        An object that identifies the name of a control parameter, its current value, and whether it has been customized.

        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 hasParameters() method.

        Returns:
        An object that identifies the name of a control parameter, its current value, and whether it has been customized.

      • lastUpdateReason

        public final String lastUpdateReason()

        The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.

        Returns:
        The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.

      • 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)