Class: AWSCDK::GuardDuty::CfnMemberProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
guard_duty/cfn_member_props.rb

Overview

Properties for defining a CfnMember.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email:, detector_id: nil, disable_email_notification: nil, member_id: nil, message: nil, status: nil) ⇒ CfnMemberProps

Returns a new instance of CfnMemberProps.

Parameters:

  • email (String) —

    The email address associated with the member account.

  • detector_id (String, nil) (defaults to: nil) —

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

  • disable_email_notification (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • member_id (String, nil) (defaults to: nil) —

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

  • message (String, nil) (defaults to: nil) —

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

  • status (String, nil) (defaults to: nil) —

    You can use the Status property to update the status of the relationship between the member account and its administrator account.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'guard_duty/cfn_member_props.rb', line 15

def initialize(email:, detector_id: nil, disable_email_notification: nil, member_id: nil, message: nil, status: nil)
  @email = email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "email")
  @detector_id = detector_id
  Jsii::Type.check_type(@detector_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "detectorId") unless @detector_id.nil?
  @disable_email_notification = disable_email_notification
  Jsii::Type.check_type(@disable_email_notification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableEmailNotification") unless @disable_email_notification.nil?
  @member_id = member_id
  Jsii::Type.check_type(@member_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "memberId") unless @member_id.nil?
  @message = message
  Jsii::Type.check_type(@message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "message") unless @message.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#detector_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'guard_duty/cfn_member_props.rb', line 39

def detector_id
  @detector_id
end

#disable_email_notification ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



44
45
46
 
# File 'guard_duty/cfn_member_props.rb', line 44

def disable_email_notification
  @disable_email_notification
end

#email ⇒ String (readonly)

The email address associated with the member account.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'guard_duty/cfn_member_props.rb', line 34

def email
  @email
end

#member_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'guard_duty/cfn_member_props.rb', line 49

def member_id
  @member_id
end

#message ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'guard_duty/cfn_member_props.rb', line 54

def message
  @message
end

#status ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'guard_duty/cfn_member_props.rb', line 61

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'guard_duty/cfn_member_props.rb', line 63

def self.jsii_properties
  {
    :email => "email",
    :detector_id => "detectorId",
    :disable_email_notification => "disableEmailNotification",
    :member_id => "memberId",
    :message => "message",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'guard_duty/cfn_member_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "email" => @email,
    "detectorId" => @detector_id,
    "disableEmailNotification" => @disable_email_notification,
    "memberId" => @member_id,
    "message" => @message,
    "status" => @status,
  })
  result.compact
end