AWS::Detective::MemberInvitation
The AWS::Detective::MemberInvitation
resource is an Amazon Detective
resource type that sends an invitation to join a Detective behavior graph. The
invitation is sent from the master account to the root user email address of an AWS
account.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Detective::MemberInvitation", "Properties" : { "GraphArn" :
String
, "MemberEmailAddress" :String
, "MemberId" :String
, "Message" :String
} }
YAML
Type: AWS::Detective::MemberInvitation Properties: GraphArn:
String
MemberEmailAddress:String
MemberId:String
Message:String
Properties
GraphArn
-
The ARN of the behavior graph to invite the account to contribute data to.
Required: Yes
Type: String
Update requires: Replacement
MemberEmailAddress
-
The root user email address of the invited account. If the email address provided is not the root user email address for the provided account, the invitation creation fails.
Required: Yes
Type: String
Update requires: No interruption
MemberId
-
The AWS account identifier of the invited account
Required: Yes
Type: String
Update requires: Replacement
Message
-
Customized text to include in the invitation email message.
Required: No
Type: String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the ARN of the behavior graph and the member account
identifier, separated by a pipe character ('|').
For more information about using the Ref
function, see Ref.
Examples
Sending a behavior graph invitation to a member account
This example shows how to declare a new
AWS:Detective:MemberInvitation
resource to create a new
invitation to a member account.
JSON
"MemberInvitation": { "Type": "AWS::Detective::MemberInvitation", "Properties": { "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899", "MemberId": "444455556666", "MemberEmailAddress": "mmajor@example.com", "Message": "This is Paul Santos. I need to add your account to the data we use for security investigation in Detective. If you have any questions, contact me at psantos@example.com." } }
YAML
MemberInvitation: Type: AWS::Detective::MemberInvitation Properties: GraphArn: "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" MemberId: 444455556666 MemberEmailAddress: mmajor@example.com Message: This is Paul Santos. I need to add your account to the data we use for security investigation in Detective. If you have any questions, contact me at psantos@example.com.