Module Values.SecurityControlSource

A security control in Security Hub CSPM describes a security best practice related to a specific resource.

Sourcetype nonrec t = {
  1. securityControlId : NonEmptyString.t option;
    (*

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

    *)
  2. securityControlArn : NonEmptyString.t option;
    (*

    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.

    *)
  3. title : NonEmptyString.t option;
    (*

    The title of a security control.

    *)
  4. description : NonEmptyString.t option;
    (*

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

    *)
  5. remediationUrl : NonEmptyString.t option;
    (*

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

    *)
  6. severityRating : SeverityRating.t option;
    (*

    The severity of a security control. For more information about how Security Hub CSPM determines control severity, see Assigning severity to control findings in the Security Hub CSPM User Guide.

    *)
  7. securityControlStatus : ControlStatus.t option;
    (*

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

    *)
  8. updateStatus : UpdateStatus.t option;
    (*

    Identifies whether customizable properties of a security control are reflected in Security Hub CSPM findings. A status of READY indicates that Security Hub CSPM uses the current control parameter values when running security checks of the control. A status of UPDATING indicates that all security checks might not use the current parameter values.

    *)
  9. parameters : Parameters.t option;
    (*

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

    *)
  10. lastUpdateReason : AlphaNumericNonEmptyString.t option;
    (*

    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.

    *)
}
Sourceval make : ?securityControlId:??? -> ?securityControlArn:??? -> ?title:??? -> ?description:??? -> ?remediationUrl:??? -> ?severityRating:??? -> ?securityControlStatus:??? -> ?updateStatus:??? -> ?parameters:??? -> ?lastUpdateReason:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of NonEmptyString.t ] * [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Boolean of Boolean.t | `Double of Double.t | `Integer of Integer.t | `List of [> `Integer of Integer.t | `String of NonEmptyString.t ] list | `String of NonEmptyString.t ]) list ]) list ]) list | `String of NonEmptyString.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t