CfnMemberInvitationProps
- class aws_cdk.aws_detective.CfnMemberInvitationProps(*, graph_arn, member_email_address, member_id, disable_email_notification=None, message=None)
Bases:
object
Properties for defining a
CfnMemberInvitation
.- Parameters:
graph_arn (
str
) – The ARN of the behavior graph to invite the account to contribute data to.member_email_address (
str
) – 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.member_id (
str
) – The AWS account identifier of the invited account.disable_email_notification (
Union
[bool
,IResolvable
,None
]) – Whether to send an invitation email to the member account. If set to true, the member account does not receive an invitation email. Default: - falsemessage (
Optional
[str
]) – Customized text to include in the invitation email message.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_detective as detective cfn_member_invitation_props = detective.CfnMemberInvitationProps( graph_arn="graphArn", member_email_address="memberEmailAddress", member_id="memberId", # the properties below are optional disable_email_notification=False, message="message" )
Attributes
- disable_email_notification
Whether to send an invitation email to the member account.
If set to true, the member account does not receive an invitation email.
- graph_arn
The ARN of the behavior graph to invite the account to contribute data to.
- member_email_address
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.
- member_id
The AWS account identifier of the invited account.
- message
Customized text to include in the invitation email message.