Class: Aws::Detective::Types::CreateMembersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb

Overview

Note:

When making an API call, you may pass CreateMembersRequest data as a hash:

{
  graph_arn: "GraphArn", # required
  message: "EmailMessage",
  disable_email_notification: false,
  accounts: [ # required
    {
      account_id: "AccountId", # required
      email_address: "EmailAddress", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accountsArray<Types::Account>

The list of AWS accounts to invite to become member accounts in the behavior graph. You can invite up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the AWS account root user email address.

Returns:



152
153
154
155
156
157
158
159
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 152

class CreateMembersRequest < Struct.new(
  :graph_arn,
  :message,
  :disable_email_notification,
  :accounts)
  SENSITIVE = []
  include Aws::Structure
end

#disable_email_notificationBoolean

if set to true, then the member accounts do not receive email notifications. By default, this is set to false, and the member accounts receive email notifications.

Returns:

  • (Boolean)


152
153
154
155
156
157
158
159
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 152

class CreateMembersRequest < Struct.new(
  :graph_arn,
  :message,
  :disable_email_notification,
  :accounts)
  SENSITIVE = []
  include Aws::Structure
end

#graph_arnString

The ARN of the behavior graph to invite the member accounts to contribute their data to.

Returns:

  • (String)


152
153
154
155
156
157
158
159
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 152

class CreateMembersRequest < Struct.new(
  :graph_arn,
  :message,
  :disable_email_notification,
  :accounts)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

Customized message text to include in the invitation email message to the invited member accounts.

Returns:

  • (String)


152
153
154
155
156
157
158
159
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 152

class CreateMembersRequest < Struct.new(
  :graph_arn,
  :message,
  :disable_email_notification,
  :accounts)
  SENSITIVE = []
  include Aws::Structure
end