Class OnCloudTrailBucketEventOptions

Options for the onCloudTrailPutObject method.

Inheritance

object

OnCloudTrailBucketEventOptions

Implements

IOnCloudTrailBucketEventOptions

IOnEventOptions

IEventCommonOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class OnCloudTrailBucketEventOptions : IOnCloudTrailBucketEventOptions, IOnEventOptions, IEventCommonOptions

Syntax (vb)

Public Class OnCloudTrailBucketEventOptions Implements IOnCloudTrailBucketEventOptions, IOnEventOptions, IEventCommonOptions

Remarks

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.Events;
            using Amazon.CDK.AWS.S3;
            using Constructs;

            Construct construct;
            var detail;
            IRuleTarget ruleTarget;
            var onCloudTrailBucketEventOptions = new OnCloudTrailBucketEventOptions {
                CrossStackScope = construct,
                Description = "description",
                EventPattern = new EventPattern {
                    Account = new [] { "account" },
                    Detail = new Dictionary<string, object> {
                        { "detailKey", detail }
                    },
                    DetailType = new [] { "detailType" },
                    Id = new [] { "id" },
                    Region = new [] { "region" },
                    Resources = new [] { "resources" },
                    Source = new [] { "source" },
                    Time = new [] { "time" },
                    Version = new [] { "version" }
                },
                Paths = new [] { "paths" },
                RuleName = "ruleName",
                Target = ruleTarget
            };

Synopsis

Constructors

OnCloudTrailBucketEventOptions()

Options for the onCloudTrailPutObject method.

Properties

CrossStackScope	The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
Description	A description of the rule's purpose.
EventPattern	Additional restrictions for the event to route to the specified target.
Paths	Only watch changes to these object paths.
RuleName	A name for the rule.
Target	The target to register for the event.

Constructors

OnCloudTrailBucketEventOptions()

Options for the onCloudTrailPutObject method.

public OnCloudTrailBucketEventOptions()

Remarks

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.Events;
            using Amazon.CDK.AWS.S3;
            using Constructs;

            Construct construct;
            var detail;
            IRuleTarget ruleTarget;
            var onCloudTrailBucketEventOptions = new OnCloudTrailBucketEventOptions {
                CrossStackScope = construct,
                Description = "description",
                EventPattern = new EventPattern {
                    Account = new [] { "account" },
                    Detail = new Dictionary<string, object> {
                        { "detailKey", detail }
                    },
                    DetailType = new [] { "detailType" },
                    Id = new [] { "id" },
                    Region = new [] { "region" },
                    Resources = new [] { "resources" },
                    Source = new [] { "source" },
                    Time = new [] { "time" },
                    Version = new [] { "version" }
                },
                Paths = new [] { "paths" },
                RuleName = "ruleName",
                Target = ruleTarget
            };

Properties

CrossStackScope

The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).

public Construct? CrossStackScope { get; set; }

Property Value

Construct

Remarks

This helps dealing with cycles that often arise in these situations.

Default: - none (the main scope will be used, even for cross-stack Events)

Description

A description of the rule's purpose.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - No description

EventPattern

Additional restrictions for the event to route to the specified target.

public IEventPattern? EventPattern { get; set; }

Property Value

IEventPattern

Remarks

The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.

Default: - No additional filtering based on an event pattern.

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html

Paths

Only watch changes to these object paths.

public string[]? Paths { get; set; }

Property Value

string[]

Remarks

Default: - Watch changes to all objects

RuleName

A name for the rule.

public string? RuleName { get; set; }

Property Value

string

Remarks

Default: AWS CloudFormation generates a unique physical ID.

Target

The target to register for the event.

public IRuleTarget? Target { get; set; }

Property Value

IRuleTarget

Remarks

Default: - No target is added to the rule. Use addTarget() to add a target.

Implements

IOnCloudTrailBucketEventOptions

IOnEventOptions

IEventCommonOptions