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.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.174Z") @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()
         .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
    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()
     
    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.
    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

    • getDetectorId

      @Stability(Stable) @NotNull String getDetectorId()
      The ID of the detector associated with the GuardDuty service to add the member to.

    • getEmail

      @Stability(Stable) @NotNull String getEmail()
      The email address associated with the member account.

    • getMemberId

      @Stability(Stable) @NotNull String getMemberId()
      The AWS account ID of the account to designate as a member.

    • getDisableEmailNotification

      @Stability(Stable) @Nullable default Object getDisableEmailNotification()
      Specifies whether or not to disable email notification for the member account that you invite.

    • 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.

    • 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.

    • builder

      @Stability(Stable) static CfnMemberProps.Builder builder()
      Returns:
      a CfnMemberProps.Builder of CfnMemberProps