software.amazon.awscdk.services.detective

Class CfnMemberInvitation

java.lang.Object

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.detective.CfnMemberInvitation

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:50.022Z")
public class CfnMemberInvitation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Detective::MemberInvitation`.

The AWS::Detective::MemberInvitation resource is an Amazon Detective resource type that creates an invitation to join a Detective behavior graph. The administrator account can choose whether to send an email notification of the invitation to the root user email address of the AWS 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.detective.*;
 CfnMemberInvitation cfnMemberInvitation = CfnMemberInvitation.Builder.create(this, "MyCfnMemberInvitation")
         .graphArn("graphArn")
         .memberEmailAddress("memberEmailAddress")
         .memberId("memberId")
         // the properties below are optional
         .disableEmailNotification(false)
         .message("message")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMemberInvitation.Builder A fluent builder for CfnMemberInvitation.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMemberInvitation(Construct scope, java.lang.String id, CfnMemberInvitationProps props) Create a new `AWS::Detective::MemberInvitation`.
protected	CfnMemberInvitation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMemberInvitation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDisableEmailNotification() Whether to send an invitation email to the member account.
java.lang.String	getGraphArn() The ARN of the behavior graph to invite the account to contribute data to.
java.lang.String	getMemberEmailAddress() The root user email address of the invited account.
java.lang.String	getMemberId() The AWS account identifier of the invited account.
java.lang.String	getMessage() Customized text to include in the invitation email message.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDisableEmailNotification(java.lang.Boolean value) Whether to send an invitation email to the member account.
void	setDisableEmailNotification(IResolvable value) Whether to send an invitation email to the member account.
void	setGraphArn(java.lang.String value) The ARN of the behavior graph to invite the account to contribute data to.
void	setMemberEmailAddress(java.lang.String value) The root user email address of the invited account.
void	setMemberId(java.lang.String value) The AWS account identifier of the invited account.
void	setMessage(java.lang.String value) Customized text to include in the invitation email message.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMemberInvitation

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

CfnMemberInvitation

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

CfnMemberInvitation

public CfnMemberInvitation(Construct scope,
                           java.lang.String id,
                           CfnMemberInvitationProps props)

Create a new `AWS::Detective::MemberInvitation`.

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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getGraphArn

public java.lang.String getGraphArn()

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

setGraphArn

public void setGraphArn(java.lang.String value)

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

getMemberEmailAddress

public java.lang.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.

setMemberEmailAddress

public void setMemberEmailAddress(java.lang.String value)

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.

getMemberId

public java.lang.String getMemberId()

The AWS account identifier of the invited account.

setMemberId

public void setMemberId(java.lang.String value)

The AWS account identifier of the invited account.

getDisableEmailNotification

public java.lang.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.

setDisableEmailNotification

public void setDisableEmailNotification(java.lang.Boolean value)

Whether to send an invitation email to the member account.

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

setDisableEmailNotification

public void setDisableEmailNotification(IResolvable value)

Whether to send an invitation email to the member account.

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

getMessage

public java.lang.String getMessage()

Customized text to include in the invitation email message.

setMessage

public void setMessage(java.lang.String value)

Customized text to include in the invitation email message.