CfnMemberProps

class aws_cdk.aws_guardduty.CfnMemberProps(*, detector_id, email, member_id, disable_email_notification=None, message=None, status=None)

Bases: object

Properties for defining a CfnMember.

Parameters:

  • detector_id (str) – The ID of the detector associated with the GuardDuty service to add the member to.

  • email (str) – The email address associated with the member account.

  • member_id (str) – The AWS account ID of the account to designate as a member.

  • disable_email_notification (Union[bool, IResolvable, None]) – Specifies whether or not to disable email notification for the member account that you invite.

  • message (Optional[str]) – The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.

  • status (Optional[str]) – 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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_guardduty as guardduty

cfn_member_props = guardduty.CfnMemberProps(
    detector_id="detectorId",
    email="email",
    member_id="memberId",

    # the properties below are optional
    disable_email_notification=False,
    message="message",
    status="status"
)

Attributes

detector_id

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-detectorid

disable_email_notification

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-disableemailnotification

email

The email address associated with the member account.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-email

member_id

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-memberid

message

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-message

status

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-status