Package software.amazon.awscdk.services.guardduty

Class CfnMember

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.guardduty.CfnMember
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.173Z") @Stability(Stable) public class CfnMember extends CfnResource implements IInspectable
A CloudFormation AWS::GuardDuty::Member.

You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account. If the value of the Status property is not provided or is set to Created , a member account is created but not invited. If the value of the Status property is set to Invited , a member account is created and invited. An AWS::GuardDuty::Member resource must be created with the Status property set to Invited before the AWS::GuardDuty::Master resource can be created in a GuardDuty member account.

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.*;
 CfnMember cfnMember = CfnMember.Builder.create(this, "MyCfnMember")
         .detectorId("detectorId")
         .email("email")
         .memberId("memberId")
         // the properties below are optional
         .disableEmailNotification(false)
         .message("message")
         .status("status")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMember

      protected CfnMember(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMember

      protected CfnMember(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMember

      @Stability(Stable) public CfnMember(@NotNull Construct scope, @NotNull String id, @NotNull CfnMemberProps props)
      Create a new AWS::GuardDuty::Member.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDetectorId

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

    • setDetectorId

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

    • getEmail

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

    • setEmail

      @Stability(Stable) public void setEmail(@NotNull String value)
      The email address associated with the member account.

    • getMemberId

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

    • setMemberId

      @Stability(Stable) public void setMemberId(@NotNull String value)
      The AWS account ID of the account to designate as a member.

    • getDisableEmailNotification

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

    • setDisableEmailNotification

      @Stability(Stable) public void setDisableEmailNotification(@Nullable Boolean value)
      Specifies whether or not to disable email notification for the member account that you invite.

    • setDisableEmailNotification

      @Stability(Stable) public void setDisableEmailNotification(@Nullable IResolvable value)
      Specifies whether or not to disable email notification for the member account that you invite.

    • getMessage

      @Stability(Stable) @Nullable public String getMessage()
      The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

    • setMessage

      @Stability(Stable) public void setMessage(@Nullable String value)
      The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

    • getStatus

      @Stability(Stable) @Nullable public 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.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      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.