AWS::GuardDuty::Master - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::GuardDuty::Master

You can use the AWS::GuardDuty::Master resource in a GuardDuty member account to accept an invitation from a GuardDuty administrator account. The invitation to the member account must be sent prior to using the AWS::GuardDuty::Master resource to accept the administrator account's invitation. You can invite a member account by using the InviteMembers operation of the GuardDuty API, or by creating an AWS::GuardDuty::Member resource.

Syntax

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

JSON

{
  "Type" : "AWS::GuardDuty::Master",
  "Properties" : {
      "DetectorId" : String,
      "InvitationId" : String,
      "MasterId" : String
    }
}

YAML

Type: AWS::GuardDuty::Master
Properties:
  DetectorId: String
  InvitationId: String
  MasterId: String

Properties

DetectorId

The unique ID of the detector of the GuardDuty member account.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Required: Yes

Type: String

Minimum: 1

Maximum: 300

Update requires: Replacement

InvitationId

The ID of the invitation that is sent to the account designated as a member account. You can find the invitation ID by running the ListInvitations in the GuardDuty API Reference.

Required: No

Type: String

Update requires: Replacement

MasterId

The Amazon account ID of the account designated as the GuardDuty administrator account.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique ID of the GuardDuty administrator account, such as 111122223333.

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

Examples

Declare a Master Resource

To declare a GuardDutyMaster resource:

JSON

"GDMaster": {
    "Type" : "AWS::GuardDuty::Master",
    "Properties" : {
        "DetectorId" : "a12abc34d567e8fa901bc2d34e56789f0",
        "MasterId" : "111122223333",
        "InvitationId" : "84b097800250d17d1872b34c4daadcf5"
    }
}

YAML

GDMaster:
    Type: AWS::GuardDuty::Master
    Properties:
        DetectorId: "a12abc34d567e8fa901bc2d34e56789f0"
        MasterId: "111122223333"
        InvitationId: "84b097800250d17d1872b34c4daadcf5"