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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.704Z")
 @Stability(value=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()
         .detectorId("detectorId")
         .email("email")
         .memberId("memberId")
         // the properties below are optional
         .disableEmailNotification(false)
         .message("message")
         .status("status")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnMemberProps.Builder	builder()
String	getDetectorId() The ID of the detector associated with the 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.
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 Detail

getDetectorId

@Stability(value=Stable)
 @NotNull
String getDetectorId()

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

getEmail

@Stability(value=Stable)
 @NotNull
String getEmail()

The email address associated with the member account.

getMemberId

@Stability(value=Stable)
 @NotNull
String getMemberId()

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

getDisableEmailNotification

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

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

getMessage

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

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

getStatus

@Stability(value=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.

builder

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

Returns:

a CfnMemberProps.Builder of CfnMemberProps