Class: AWSCDK::Detective::CfnMemberInvitationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
detective/cfn_member_invitation_props.rb

Overview

Properties for defining a CfnMemberInvitation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(graph_arn:, member_email_address:, member_id:, disable_email_notification: nil, message: nil) ⇒ CfnMemberInvitationProps

Returns a new instance of CfnMemberInvitationProps.

Parameters:

  • graph_arn (String) —

    The ARN of the behavior graph to invite the account to contribute data to.

  • member_email_address (String) —

    The root user email address of the invited account.

  • member_id (String) —

    The AWS account identifier of the invited account.

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

    Whether to send an invitation email to the member account.

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

    Customized text to include in the invitation email message.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'detective/cfn_member_invitation_props.rb', line 14

def initialize(graph_arn:, member_email_address:, member_id:, disable_email_notification: nil, message: nil)
  @graph_arn = graph_arn
  Jsii::Type.check_type(@graph_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "graphArn")
  @member_email_address = member_email_address
  Jsii::Type.check_type(@member_email_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "memberEmailAddress")
  @member_id = member_id
  Jsii::Type.check_type(@member_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "memberId")
  @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?
  @message = message
  Jsii::Type.check_type(@message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "message") unless @message.nil?
end

Instance Attribute Details

#disable_email_notification ⇒ Boolean, ... (readonly)

Note:

Default: - false

Whether to send an invitation email to the member account.

If set to true, the member account does not receive an invitation email.

Returns:

See Also:



51
52
53
 
# File 'detective/cfn_member_invitation_props.rb', line 51

def disable_email_notification
  @disable_email_notification
end

#graph_arn ⇒ String (readonly)

The ARN of the behavior graph to invite the account to contribute data to.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'detective/cfn_member_invitation_props.rb', line 31

def graph_arn
  @graph_arn
end

#member_email_address ⇒ String (readonly)

The root user email address of the invited account.

If the email address provided is not the root user email address for the provided account, the invitation creation fails.

Returns:

  • (String)

See Also:



38
39
40
 
# File 'detective/cfn_member_invitation_props.rb', line 38

def member_email_address
  @member_email_address
end

#member_id ⇒ String (readonly)

The AWS account identifier of the invited account.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'detective/cfn_member_invitation_props.rb', line 43

def member_id
  @member_id
end

#message ⇒ String? (readonly)

Customized text to include in the invitation email message.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'detective/cfn_member_invitation_props.rb', line 56

def message
  @message
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'detective/cfn_member_invitation_props.rb', line 58

def self.jsii_properties
  {
    :graph_arn => "graphArn",
    :member_email_address => "memberEmailAddress",
    :member_id => "memberId",
    :disable_email_notification => "disableEmailNotification",
    :message => "message",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'detective/cfn_member_invitation_props.rb', line 68

def to_jsii
  result = {}
  result.merge!({
    "graphArn" => @graph_arn,
    "memberEmailAddress" => @member_email_address,
    "memberId" => @member_id,
    "disableEmailNotification" => @disable_email_notification,
    "message" => @message,
  })
  result.compact
end