Class OnImageScanCompletedOptions
Options for the OnImageScanCompleted method.
Inheritance
Namespace: Amazon.CDK.AWS.ECR
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OnImageScanCompletedOptions : Object, IOnImageScanCompletedOptions, IOnEventOptions, IEventCommonOptions
Syntax (vb)
Public Class OnImageScanCompletedOptions
Inherits Object
Implements IOnImageScanCompletedOptions, 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.ECR;
using Amazon.CDK.AWS.Events;
using Constructs;
Construct construct;
var detail;
IRuleTarget ruleTarget;
var onImageScanCompletedOptions = new OnImageScanCompletedOptions {
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" }
},
ImageTags = new [] { "imageTags" },
RuleName = "ruleName",
Target = ruleTarget
};
Synopsis
Constructors
OnImageScanCompletedOptions() |
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. |
ImageTags | Only watch changes to the image tags specified. |
RuleName | A name for the rule. |
Target | The target to register for the event. |
Constructors
OnImageScanCompletedOptions()
public OnImageScanCompletedOptions()
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
Constructs.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
System.String
Remarks
Default: - No description
EventPattern
Additional restrictions for the event to route to the specified target.
public IEventPattern EventPattern { get; set; }
Property Value
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
ImageTags
Only watch changes to the image tags specified.
public string[] ImageTags { get; set; }
Property Value
System.String[]
Remarks
Leave it undefined to watch the full repository.
Default: - Watch the changes to the repository with all image tags
RuleName
A name for the rule.
public string RuleName { get; set; }
Property Value
System.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
Remarks
Default: - No target is added to the rule. Use addTarget()
to add a target.