software.amazon.awscdk.services.guardduty

Class CfnMember

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.guardduty.CfnMember

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.500Z")
public class CfnMember
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GuardDuty::Member`.

You can use the AWS::GuardDuty::Member resource to add an AWS account as a member account to the current administrator account. If the value of the Status property is not provided or is set to Created , a member account is created but not invited. If the value of the Status property is set to Invited , a member account is created and invited. An AWS::GuardDuty::Member resource must be created with the Status property set to Invited before the AWS::GuardDuty::Master resource can be created in a member 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.guardduty.*;
 CfnMember cfnMember = CfnMember.Builder.create(this, "MyCfnMember")
         .detectorId("detectorId")
         .email("email")
         .memberId("memberId")
         // the properties below are optional
         .disableEmailNotification(false)
         .message("message")
         .status("status")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnMember(Construct scope, java.lang.String id, CfnMemberProps props) Create a new `AWS::GuardDuty::Member`.
protected	CfnMember(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMember(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.String	getDetectorId() The ID of the detector associated with the service to add the member to.
java.lang.Object	getDisableEmailNotification() Specifies whether or not to disable email notification for the member account that you invite.
java.lang.String	getEmail() The email address associated with the member account.
java.lang.String	getMemberId() The AWS account ID of the account to designate as a member.
java.lang.String	getMessage() The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
java.lang.String	getStatus() You can use the `Status` property to update the status of the relationship between the member account and its administrator account.
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	setDetectorId(java.lang.String value) The ID of the detector associated with the service to add the member to.
void	setDisableEmailNotification(java.lang.Boolean value) Specifies whether or not to disable email notification for the member account that you invite.
void	setDisableEmailNotification(IResolvable value) Specifies whether or not to disable email notification for the member account that you invite.
void	setEmail(java.lang.String value) The email address associated with the member account.
void	setMemberId(java.lang.String value) The AWS account ID of the account to designate as a member.
void	setMessage(java.lang.String value) The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
void	setStatus(java.lang.String value) You can use the `Status` property to update the status of the relationship between the member account and its administrator account.

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

CfnMember

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

CfnMember

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

CfnMember

public CfnMember(Construct scope,
                 java.lang.String id,
                 CfnMemberProps props)

Create a new `AWS::GuardDuty::Member`.

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

getDetectorId

public java.lang.String getDetectorId()

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

setDetectorId

public void setDetectorId(java.lang.String value)

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

getEmail

public java.lang.String getEmail()

The email address associated with the member account.

setEmail

public void setEmail(java.lang.String value)

The email address associated with the member account.

getMemberId

public java.lang.String getMemberId()

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

setMemberId

public void setMemberId(java.lang.String value)

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

getDisableEmailNotification

public java.lang.Object getDisableEmailNotification()

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

setDisableEmailNotification

public void setDisableEmailNotification(java.lang.Boolean value)

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

setDisableEmailNotification

public void setDisableEmailNotification(IResolvable value)

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

getMessage

public java.lang.String getMessage()

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

setMessage

public void setMessage(java.lang.String value)

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

getStatus

public java.lang.String getStatus()

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.

setStatus

public void setStatus(java.lang.String value)

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.