awsdetective

Documentation

Index

• func CfnGraph_CFN_RESOURCE_TYPE_NAME() *string
• func CfnGraph_IsCfnElement(x interface{}) *bool
• func CfnGraph_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnGraph_IsConstruct(x interface{}) *bool
• func CfnMemberInvitation_CFN_RESOURCE_TYPE_NAME() *string
• func CfnMemberInvitation_IsCfnElement(x interface{}) *bool
• func CfnMemberInvitation_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnMemberInvitation_IsConstruct(x interface{}) *bool
• func NewCfnGraph_Override(c CfnGraph, scope awscdk.Construct, id *string, props *CfnGraphProps)
• func NewCfnMemberInvitation_Override(c CfnMemberInvitation, scope awscdk.Construct, id *string, ...)
• type CfnGraph
  • func NewCfnGraph(scope awscdk.Construct, id *string, props *CfnGraphProps) CfnGraph
• type CfnGraphProps
• type CfnMemberInvitation
  • func NewCfnMemberInvitation(scope awscdk.Construct, id *string, props *CfnMemberInvitationProps) CfnMemberInvitation
• type CfnMemberInvitationProps

Functions

func CfnGraph_CFN_RESOURCE_TYPE_NAME

func CfnGraph_CFN_RESOURCE_TYPE_NAME() *string

func CfnGraph_IsCfnElement

func CfnGraph_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnGraph_IsCfnResource

func CfnGraph_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGraph_IsConstruct

func CfnGraph_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnMemberInvitation_CFN_RESOURCE_TYPE_NAME

func CfnMemberInvitation_CFN_RESOURCE_TYPE_NAME() *string

func CfnMemberInvitation_IsCfnElement

func CfnMemberInvitation_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnMemberInvitation_IsCfnResource

func CfnMemberInvitation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMemberInvitation_IsConstruct

func CfnMemberInvitation_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnGraph_Override

func NewCfnGraph_Override(c CfnGraph, scope awscdk.Construct, id *string, props *CfnGraphProps)

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

func NewCfnMemberInvitation_Override

func NewCfnMemberInvitation_Override(c CfnMemberInvitation, scope awscdk.Construct, id *string, props *CfnMemberInvitationProps)

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

Types

type CfnGraph

type CfnGraph interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Detective::Graph`.

The `AWS::Detective::Graph` resource is an Amazon Detective resource type that creates a Detective behavior graph. The requesting account becomes the administrator account for the behavior graph.

TODO: EXAMPLE

func NewCfnGraph

func NewCfnGraph(scope awscdk.Construct, id *string, props *CfnGraphProps) CfnGraph

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

type CfnGraphProps

type CfnGraphProps struct {
	// The tag values to assign to the new behavior graph.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnGraph`.

TODO: EXAMPLE

type CfnMemberInvitation

type CfnMemberInvitation interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DisableEmailNotification() interface{}
	SetDisableEmailNotification(val interface{})
	GraphArn() *string
	SetGraphArn(val *string)
	LogicalId() *string
	MemberEmailAddress() *string
	SetMemberEmailAddress(val *string)
	MemberId() *string
	SetMemberId(val *string)
	Message() *string
	SetMessage(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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.

TODO: EXAMPLE

func NewCfnMemberInvitation

func NewCfnMemberInvitation(scope awscdk.Construct, id *string, props *CfnMemberInvitationProps) CfnMemberInvitation

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

type CfnMemberInvitationProps

type CfnMemberInvitationProps struct {
	// The ARN of the behavior graph to invite the account to contribute data to.
	GraphArn *string `json:"graphArn" yaml:"graphArn"`
	// 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.
	MemberEmailAddress *string `json:"memberEmailAddress" yaml:"memberEmailAddress"`
	// The AWS account identifier of the invited account.
	MemberId *string `json:"memberId" yaml:"memberId"`
	// Whether to send an invitation email to the member account.
	//
	// If set to true, the member account does not receive an invitation email.
	DisableEmailNotification interface{} `json:"disableEmailNotification" yaml:"disableEmailNotification"`
	// Customized text to include in the invitation email message.
	Message *string `json:"message" yaml:"message"`
}

Properties for defining a `CfnMemberInvitation`.

TODO: EXAMPLE