Module Values.SecurityControlDefinitionSource

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

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

    The title of a security control.

    *)
  3. 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.

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

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

    *)
  5. 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.

    *)
  6. currentRegionAvailability : RegionAvailabilityStatus.t option;
    (*

    Specifies whether a security control is available in the current Amazon Web Services Region.

    *)
  7. customizableProperties : CustomizableProperties.t option;
    (*

    Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that donโ€™t support custom properties.

    *)
  8. parameterDefinitions : ParameterDefinitions.t option;
    (*

    An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

    *)
}
Sourceval make : ?securityControlId:??? -> ?title:??? -> ?description:??? -> ?remediationUrl:??? -> ?severityRating:??? -> ?currentRegionAvailability:??? -> ?customizableProperties:??? -> ?parameterDefinitions:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `Map of ([> `String of NonEmptyString.t ] * [> `Structure of (string * [> `String of NonEmptyString.t | `Structure 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 ]) 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