software.amazon.awscdk.services.guardduty

Class CfnMember

java.lang.Object

software.amazon.jsii.JsiiObject

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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.421Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMember(Construct scope, 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 Map<String,Object>	getCfnProperties()
String	getDetectorId() The ID of the detector associated with the service to add the member to.
Object	getDisableEmailNotification() Specifies whether or not to disable email notification for the member account that you invite.
String	getEmail() The email address associated with the member account.
String	getMemberId() The AWS account ID of the account to designate as a member.
String	getMessage() The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDetectorId(String value) The ID of the detector associated with the service to add the member to.
void	setDisableEmailNotification(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(String value) The email address associated with the member account.
void	setMemberId(String value) The AWS account ID of the account to designate as a member.
void	setMessage(String value) The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
void	setStatus(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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnMember(@NotNull
                                          Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDetectorId

@Stability(value=Stable)
 @NotNull
public String getDetectorId()

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

setDetectorId

@Stability(value=Stable)
public void setDetectorId(@NotNull
                                                   String value)

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

getEmail

@Stability(value=Stable)
 @NotNull
public String getEmail()

The email address associated with the member account.

setEmail

@Stability(value=Stable)
public void setEmail(@NotNull
                                              String value)

The email address associated with the member account.

getMemberId

@Stability(value=Stable)
 @NotNull
public String getMemberId()

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

setMemberId

@Stability(value=Stable)
public void setMemberId(@NotNull
                                                 String value)

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

getDisableEmailNotification

@Stability(value=Stable)
 @Nullable
public Object getDisableEmailNotification()

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

setDisableEmailNotification

@Stability(value=Stable)
public void setDisableEmailNotification(@Nullable
                                                                 Boolean value)

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

setDisableEmailNotification

@Stability(value=Stable)
public void setDisableEmailNotification(@Nullable
                                                                 IResolvable value)

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

getMessage

@Stability(value=Stable)
 @Nullable
public String getMessage()

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

setMessage

@Stability(value=Stable)
public void setMessage(@Nullable
                                                String value)

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

getStatus

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setStatus(@Nullable
                                               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.