aws-cdk-lib.aws_detective.CfnMemberInvitationProps

interface CfnMemberInvitationProps

LanguageType name
.NETAmazon.CDK.AWS.Detective.CfnMemberInvitationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdetective#CfnMemberInvitationProps
Javasoftware.amazon.awscdk.services.detective.CfnMemberInvitationProps
Pythonaws_cdk.aws_detective.CfnMemberInvitationProps
TypeScript aws-cdk-lib » 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 { aws_detective as detective } from 'aws-cdk-lib';
const cfnMemberInvitationProps: detective.CfnMemberInvitationProps = {
  graphArn: 'graphArn',
  memberEmailAddress: 'memberEmailAddress',
  memberId: 'memberId',

  // the properties below are optional
  disableEmailNotification: false,
  message: 'message',
};

Properties

NameTypeDescription
graphArnstringThe ARN of the behavior graph to invite the account to contribute data to.
memberEmailAddressstringThe root user email address of the invited account.
memberIdstringThe AWS account identifier of the invited account.
disableEmailNotification?boolean | IResolvableWhether to send an invitation email to the member account.
message?stringCustomized 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.