Package software.amazon.awscdk.services.guardduty

Class CfnMaster

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.CfnMaster
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.171Z") @Stability(Stable) public class CfnMaster extends CfnResource implements IInspectable
A CloudFormation AWS::GuardDuty::Master.

You can use the AWS::GuardDuty::Master resource in a GuardDuty member account to accept an invitation from a GuardDuty administrator account. The invitation to the member account must be sent prior to using the AWS::GuardDuty::Master resource to accept the administrator account's invitation. You can invite a member account by using the InviteMembers operation of the GuardDuty API, or by creating an AWS::GuardDuty::Member resource.

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.*;
 CfnMaster cfnMaster = CfnMaster.Builder.create(this, "MyCfnMaster")
         .detectorId("detectorId")
         .masterId("masterId")
         // the properties below are optional
         .invitationId("invitationId")
         .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

    • CfnMaster

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

    • CfnMaster

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

    • CfnMaster

      @Stability(Stable) public CfnMaster(@NotNull Construct scope, @NotNull String id, @NotNull CfnMasterProps props)
      Create a new AWS::GuardDuty::Master.

      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 unique ID of the detector of the GuardDuty member account.

    • setDetectorId

      @Stability(Stable) public void setDetectorId(@NotNull String value)
      The unique ID of the detector of the GuardDuty member account.

    • getMasterId

      @Stability(Stable) @NotNull public String getMasterId()
      The AWS account ID of the account designated as the GuardDuty administrator account.

    • setMasterId

      @Stability(Stable) public void setMasterId(@NotNull String value)
      The AWS account ID of the account designated as the GuardDuty administrator account.

    • getInvitationId

      @Stability(Stable) @Nullable public String getInvitationId()
      The ID of the invitation that is sent to the account designated as a member account.

      You can find the invitation ID by using the ListInvitation action of the GuardDuty API.

    • setInvitationId

      @Stability(Stable) public void setInvitationId(@Nullable String value)
      The ID of the invitation that is sent to the account designated as a member account.

      You can find the invitation ID by using the ListInvitation action of the GuardDuty API.