Package software.amazon.awscdk.services.detective

Interface CfnMemberInvitationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMemberInvitationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:23.871Z")
@Stability(Stable)
public interface CfnMemberInvitationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMemberInvitation.

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.detective.*;
 CfnMemberInvitationProps cfnMemberInvitationProps = CfnMemberInvitationProps.builder()
         .graphArn("graphArn")
         .memberEmailAddress("memberEmailAddress")
         .memberId("memberId")
         // the properties below are optional
         .disableEmailNotification(false)
         .message("message")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMemberInvitationProps.Builder	A builder for CfnMemberInvitationProps
static final class	CfnMemberInvitationProps.Jsii$Proxy	An implementation for CfnMemberInvitationProps

Method Summary

Modifier and Type	Method	Description
static CfnMemberInvitationProps.Builder	builder()
default Object	getDisableEmailNotification()	Whether to send an invitation email to the member account.
String	getGraphArn()	The ARN of the behavior graph to invite the account to contribute data to.
String	getMemberEmailAddress()	The root user email address of the invited account.
String	getMemberId()	The AWS account identifier of the invited account.
default String	getMessage()	Customized text to include in the invitation email message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGraphArn

@Stability(Stable)
@NotNull
String getGraphArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-grapharn

getMemberEmailAddress

@Stability(Stable)
@NotNull
String getMemberEmailAddress()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberemailaddress

getMemberId

@Stability(Stable)
@NotNull
String getMemberId()

The AWS account identifier of the invited account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberid

getDisableEmailNotification

@Stability(Stable)
@Nullable
default Object getDisableEmailNotification()

Whether to send an invitation email to the member account.

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

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-disableemailnotification

getMessage

@Stability(Stable)
@Nullable
default String getMessage()

Customized text to include in the invitation email message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-message

builder

@Stability(Stable)
static CfnMemberInvitationProps.Builder builder()

Returns:

a CfnMemberInvitationProps.Builder of CfnMemberInvitationProps