interface CfnMemberInvitationProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Detective.CfnMemberInvitationProps |
![]() | software.amazon.awscdk.services.detective.CfnMemberInvitationProps |
![]() | aws_cdk.aws_detective.CfnMemberInvitationProps |
![]() | @aws-cdk/aws-detective » CfnMemberInvitationProps |
Properties for defining a CfnMemberInvitation
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as detective from '@aws-cdk/aws-detective';
const cfnMemberInvitationProps: detective.CfnMemberInvitationProps = {
graphArn: 'graphArn',
memberEmailAddress: 'memberEmailAddress',
memberId: 'memberId',
// the properties below are optional
disableEmailNotification: false,
message: 'message',
};
Properties
Name | Type | Description |
---|---|---|
graph | string | The ARN of the behavior graph to invite the account to contribute data to. |
member | string | The root user email address of the invited account. |
member | string | The AWS account identifier of the invited account. |
disable | boolean | IResolvable | Whether to send an invitation email to the member account. |
message? | string | Customized text to include in the invitation email message. |
graphArn
Type:
string
The ARN of the behavior graph to invite the account to contribute data to.
memberEmailAddress
Type:
string
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.
memberId
Type:
string
The AWS account identifier of the invited account.
disableEmailNotification?
Type:
boolean |
IResolvable
(optional)
Whether to send an invitation email to the member account.
If set to true, the member account does not receive an invitation email.
message?
Type:
string
(optional)
Customized text to include in the invitation email message.