[ aws . guardduty ]

update-detector

Description

Updates the Amazon GuardDuty detector specified by the detectorId.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-detector
--detector-id <value>
[--enable | --no-enable]
[--finding-publishing-frequency <value>]
[--data-sources <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--detector-id (string)

The unique ID of the detector to update.

--enable | --no-enable (boolean)

Specifies whether the detector is enabled or not enabled.

--finding-publishing-frequency (string)

An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.

Possible values:

• FIFTEEN_MINUTES

• ONE_HOUR

• SIX_HOURS

--data-sources (structure)

Describes which data sources will be updated.

S3Logs -> (structure)

Describes whether S3 data event logs are enabled as a data source.

Enable -> (boolean)

The status of S3 data event logs as a data source.

Kubernetes -> (structure)

Describes whether any Kubernetes logs are enabled as data sources.

AuditLogs -> (structure)

The status of Kubernetes audit logs as a data source.

Enable -> (boolean)

The status of Kubernetes audit logs as a data source.

MalwareProtection -> (structure)

Describes whether Malware Protection is enabled as a data source.

ScanEc2InstanceWithFindings -> (structure)

Describes the configuration of Malware Protection for EC2 instances with findings.

EbsVolumes -> (boolean)

Describes the configuration for scanning EBS volumes as data source.

Shorthand Syntax:

S3Logs={Enable=boolean},Kubernetes={AuditLogs={Enable=boolean}},MalwareProtection={ScanEc2InstanceWithFindings={EbsVolumes=boolean}}

JSON Syntax:

{
  "S3Logs": {
    "Enable": true|false
  },
  "Kubernetes": {
    "AuditLogs": {
      "Enable": true|false
    }
  },
  "MalwareProtection": {
    "ScanEc2InstanceWithFindings": {
      "EbsVolumes": true|false
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None