Class RepositoryTriggerOptions

Creates for a repository trigger to an SNS topic or Lambda function.

Inheritance

object

RepositoryTriggerOptions

Implements

IRepositoryTriggerOptions

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.CodeCommit

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class RepositoryTriggerOptions : IRepositoryTriggerOptions

Syntax (vb)

Public Class RepositoryTriggerOptions Implements IRepositoryTriggerOptions

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.CodeCommit;

            var repositoryTriggerOptions = new RepositoryTriggerOptions {
                Branches = new [] { "branches" },
                CustomData = "customData",
                Events = new [] { RepositoryEventTrigger.ALL },
                Name = "name"
            };

Synopsis

Constructors

RepositoryTriggerOptions()

Creates for a repository trigger to an SNS topic or Lambda function.

Properties

Branches	The names of the branches in the AWS CodeCommit repository that contain events that you want to include in the trigger.
CustomData	When an event is triggered, additional information that AWS CodeCommit includes when it sends information to the target.
Events	The repository events for which AWS CodeCommit sends information to the target, which you specified in the DestinationArn property.If you don't specify events, the trigger runs for all repository events.
Name	A name for the trigger.Triggers on a repository must have unique names.

Constructors

RepositoryTriggerOptions()

Creates for a repository trigger to an SNS topic or Lambda function.

public RepositoryTriggerOptions()

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.CodeCommit;

            var repositoryTriggerOptions = new RepositoryTriggerOptions {
                Branches = new [] { "branches" },
                CustomData = "customData",
                Events = new [] { RepositoryEventTrigger.ALL },
                Name = "name"
            };

Properties

Branches

The names of the branches in the AWS CodeCommit repository that contain events that you want to include in the trigger.

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

Property Value

string[]

Remarks

If you don't specify at least one branch, the trigger applies to all branches.

CustomData

When an event is triggered, additional information that AWS CodeCommit includes when it sends information to the target.

public string? CustomData { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Events

The repository events for which AWS CodeCommit sends information to the target, which you specified in the DestinationArn property.If you don't specify events, the trigger runs for all repository events.

public RepositoryEventTrigger[]? Events { get; set; }

Property Value

RepositoryEventTrigger[]

Remarks

ExampleMetadata: fixture=_generated

Name

A name for the trigger.Triggers on a repository must have unique names.

public string? Name { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Implements

IRepositoryTriggerOptions