interface CfnMemberProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GuardDuty.CfnMemberProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnMemberProps |
![]() | software.amazon.awscdk.services.guardduty.CfnMemberProps |
![]() | aws_cdk.aws_guardduty.CfnMemberProps |
![]() | aws-cdk-lib » aws_guardduty » CfnMemberProps |
Properties for defining a CfnMember
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
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 = {
email: 'email',
// the properties below are optional
detectorId: 'detectorId',
disableEmailNotification: false,
memberId: 'memberId',
message: 'message',
status: 'status',
};
Properties
Name | Type | Description |
---|---|---|
string | The email address associated with the member account. | |
detector | string | The ID of the detector associated with the GuardDuty service to add the member to. |
disable | boolean | IResolvable | Specifies whether or not to disable email notification for the member account that you invite. |
member | string | The AWS account ID of the account to designate as a member. |
message? | string | The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members. |
status? | string | You can use the Status property to update the status of the relationship between the member account and its administrator account. |
Type:
string
The email address associated with the member account.
detectorId?
Type:
string
(optional)
The ID of the detector associated with the GuardDuty service to add the member to.
disableEmailNotification?
Type:
boolean |
IResolvable
(optional)
Specifies whether or not to disable email notification for the member account that you invite.
memberId?
Type:
string
(optional)
The AWS account ID of the account to designate as a member.
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.