Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::GuardDuty::Detector

The AWS::GuardDuty::Detector resource creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. You must create a detector for GuardDuty to become operational.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::GuardDuty::Detector", "Properties" : { "Enable" : Boolean } }

YAML

Type: "AWS::GuardDuty::Detector" Properties: Enable: Boolean

Properties

Enable

A Boolean value that specifies whether the detector is to be enabled.

Required: Yes

Type: Boolean

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::GuardDuty::Detector resource to the intrinsic Ref function, the function returns the unique ID of the created detector.

For more information about using the Ref function, see Ref.

Examples

Declaring a GuardDuty Detector Resource

The following example shows how to declare an AWS::GuardDuty::Detector resource to create a GuardDuty detector.

JSON

"mydetector": { "Type": "AWS::GuardDuty::Detector", "Properties": { "Enable": true } }

YAML

mydetector: Type: "AWS::GuardDuty::Detector" Properties: Enable: true