Get Security Control Definition

securityhub_get_security_control_definition

R Documentation

Retrieves the definition of a security control

Description

Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.

Usage

securityhub_get_security_control_definition(SecurityControlId)

Arguments

SecurityControlId

[required] The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).

Value

A list with the following syntax:

list(
  SecurityControlDefinition = list(
    SecurityControlId = "string",
    Title = "string",
    Description = "string",
    RemediationUrl = "string",
    SeverityRating = "LOW"|"MEDIUM"|"HIGH"|"CRITICAL",
    CurrentRegionAvailability = "AVAILABLE"|"UNAVAILABLE",
    CustomizableProperties = list(
      "Parameters"
    ),
    ParameterDefinitions = list(
      list(
        Description = "string",
        ConfigurationOptions = list(
          Integer = list(
            DefaultValue = 123,
            Min = 123,
            Max = 123
          ),
          IntegerList = list(
            DefaultValue = list(
              123
            ),
            Min = 123,
            Max = 123,
            MaxItems = 123
          ),
          Double = list(
            DefaultValue = 123.0,
            Min = 123.0,
            Max = 123.0
          ),
          String = list(
            DefaultValue = "string",
            Re2Expression = "string",
            ExpressionDescription = "string"
          ),
          StringList = list(
            DefaultValue = list(
              "string"
            ),
            Re2Expression = "string",
            MaxItems = 123,
            ExpressionDescription = "string"
          ),
          Boolean = list(
            DefaultValue = TRUE|FALSE
          ),
          Enum = list(
            DefaultValue = "string",
            AllowedValues = list(
              "string"
            )
          ),
          EnumList = list(
            DefaultValue = list(
              "string"
            ),
            MaxItems = 123,
            AllowedValues = list(
              "string"
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$get_security_control_definition(
  SecurityControlId = "string"
)

Examples

## Not run: 
# The following example retrieves definition details for the specified
# security control.
svc$get_security_control_definition(
  SecurityControlId = "EC2.4"
)

## End(Not run)