Class CfnMember
You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account.
Inherited Members
Namespace: Amazon.CDK.AWS.GuardDuty
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMember : CfnResource, IInspectable, IMemberRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnMember Inherits CfnResource Implements IInspectable, IMemberRef, IConstruct, IDependable, IEnvironmentAware
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GuardDuty;
var cfnMember = new CfnMember(this, "MyCfnMember", new CfnMemberProps {
Email = "email",
// the properties below are optional
DetectorId = "detectorId",
DisableEmailNotification = false,
MemberId = "memberId",
Message = "message",
Status = "status"
});
Synopsis
Constructors
| CfnMember(Construct, string, ICfnMemberProps) | Create a new |
Properties
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | You can use the |
| CfnPropertyNames | You can use the |
| DetectorId | The ID of the detector associated with the GuardDuty service to add the member to. |
| DisableEmailNotification | Specifies whether or not to disable email notification for the member account that you invite. |
The email address associated with the member account. |
|
| MemberId | The AWS account ID of the account to designate as a member. |
| MemberRef | A reference to a Member resource. |
| Message | The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members. |
| Status | You can use the |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnMember(object) | Checks whether the given object is a CfnMember. |
| RenderProperties(IDictionary<string, object>) | You can use the |
Constructors
CfnMember(Construct, string, ICfnMemberProps)
Create a new AWS::GuardDuty::Member.
public CfnMember(Construct scope, string id, ICfnMemberProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnMemberProps
Resource properties.
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
CfnProperties
You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
CfnPropertyNames
You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
DetectorId
The ID of the detector associated with the GuardDuty service to add the member to.
public virtual string? DetectorId { get; set; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
DisableEmailNotification
Specifies whether or not to disable email notification for the member account that you invite.
public virtual object? DisableEmailNotification { get; set; }
Property Value
Remarks
Type union: either bool or IResolvable
The email address associated with the member account.
public virtual string Email { get; set; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
MemberId
The AWS account ID of the account to designate as a member.
public virtual string? MemberId { get; set; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
MemberRef
A reference to a Member resource.
public virtual IMemberReference MemberRef { get; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
Message
The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
public virtual string? Message { get; set; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
Status
You can use the Status property to update the status of the relationship between the member account and its administrator account.
public virtual string? Status { get; set; }
Property Value
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
IsCfnMember(object)
Checks whether the given object is a CfnMember.
public static bool IsCfnMember(object x)
Parameters
- x object
Returns
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
You can use the AWS::GuardDuty::Member resource to add an AWS account as a GuardDuty member account to the current GuardDuty administrator account.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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 GuardDuty member account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html
CloudformationResource: AWS::GuardDuty::Member
ExampleMetadata: fixture=_generated