Package software.amazon.awscdk.services.guardduty

Interface CfnMemberProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMemberProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:00.381Z")
@Stability(Stable)
public interface CfnMemberProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.guardduty.*;
 CfnMemberProps cfnMemberProps = CfnMemberProps.builder()
         .email("email")
         // the properties below are optional
         .detectorId("detectorId")
         .disableEmailNotification(false)
         .memberId("memberId")
         .message("message")
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMemberProps.Builder	A builder for CfnMemberProps
static final class	CfnMemberProps.Jsii$Proxy	An implementation for CfnMemberProps

Method Summary

Modifier and Type	Method	Description
static CfnMemberProps.Builder	builder()
default String	getDetectorId()	The ID of the detector associated with the GuardDuty service to add the member to.
default Object	getDisableEmailNotification()	Specifies whether or not to disable email notification for the member account that you invite.
String	getEmail()	The email address associated with the member account.
default String	getMemberId()	The AWS account ID of the account to designate as a member.
default String	getMessage()	The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
default String	getStatus()	You can use the Status property to update the status of the relationship between the member account and its administrator account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmail

@Stability(Stable)
@NotNull
String getEmail()

The email address associated with the member account.

See Also:

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

getDetectorId

@Stability(Stable)
@Nullable
default String getDetectorId()

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

See Also:

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

getDisableEmailNotification

@Stability(Stable)
@Nullable
default Object getDisableEmailNotification()

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

See Also:

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

getMemberId

@Stability(Stable)
@Nullable
default String getMemberId()

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

See Also:

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

getMessage

@Stability(Stable)
@Nullable
default String getMessage()

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

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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.

See Also:

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

builder

@Stability(Stable)
static CfnMemberProps.Builder builder()

Returns:

a CfnMemberProps.Builder of CfnMemberProps