aws-cdk-lib.aws_guardduty.CfnMemberProps

interface CfnMemberProps

LanguageType name
.NETAmazon.CDK.AWS.GuardDuty.CfnMemberProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnMemberProps
Javasoftware.amazon.awscdk.services.guardduty.CfnMemberProps
Pythonaws_cdk.aws_guardduty.CfnMemberProps
TypeScript aws-cdk-lib » aws_guardduty » CfnMemberProps

Properties for defining a CfnMember.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';
const cfnMemberProps: guardduty.CfnMemberProps = {
  detectorId: 'detectorId',
  email: 'email',
  memberId: 'memberId',

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

Properties

NameTypeDescription
detectorIdstringThe ID of the detector associated with the GuardDuty service to add the member to.
emailstringThe email address associated with the member account.
memberIdstringThe AWS account ID of the account to designate as a member.
disableEmailNotification?boolean | IResolvableSpecifies whether or not to disable email notification for the member account that you invite.
message?stringThe invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
status?stringYou can use the Status property to update the status of the relationship between the member account and its administrator account.

detectorId

Type: string

The ID of the detector associated with the GuardDuty service to add the member to.


email

Type: string

The email address associated with the member account.


memberId

Type: string

The AWS account ID of the account to designate as a member.


disableEmailNotification?

Type: boolean | IResolvable (optional)

Specifies whether or not to disable email notification for the member account that you invite.


message?

Type: string (optional)

The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.


status?

Type: string (optional)

You can use the Status property to update the status of the relationship between the member account and its administrator account.

Valid values are Created and Invited when using an AWS::GuardDuty::Member resource. If the value for this property is not provided or set to Created , a member account is created but not invited. If the value of this property is set to Invited , a member account is created and invited.