Package software.amazon.awscdk.services.codecommit

Interface CfnRepository.RepositoryTriggerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRepository.RepositoryTriggerProperty.Jsii$Proxy

Enclosing class:

CfnRepository

@Stability(Stable)
public static interface CfnRepository.RepositoryTriggerProperty
extends software.amazon.jsii.JsiiSerializable

Information about a trigger for a repository.

If you want to receive notifications about repository events, consider using notifications instead of triggers. For more information, see Configuring notifications for repository events .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codecommit.*;
 RepositoryTriggerProperty repositoryTriggerProperty = RepositoryTriggerProperty.builder()
         .destinationArn("destinationArn")
         .events(List.of("events"))
         .name("name")
         // the properties below are optional
         .branches(List.of("branches"))
         .customData("customData")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRepository.RepositoryTriggerProperty.Builder	A builder for CfnRepository.RepositoryTriggerProperty
static final class	CfnRepository.RepositoryTriggerProperty.Jsii$Proxy	An implementation for CfnRepository.RepositoryTriggerProperty

Method Summary

Modifier and Type	Method	Description
static CfnRepository.RepositoryTriggerProperty.Builder	builder()
default List<String>	getBranches()	The branches to be included in the trigger configuration.
default String	getCustomData()	Any custom data associated with the trigger to be included in the information sent to the target of the trigger.
String	getDestinationArn()	The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).
List<String>	getEvents()	The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.
String	getName()	The name of the trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationArn

@Stability(Stable)
@NotNull
String getDestinationArn()

The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-destinationarn

getEvents

@Stability(Stable)
@NotNull
List<String> getEvents()

The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.

The valid value "all" cannot be used with any other values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-events

getName

@Stability(Stable)
@NotNull
String getName()

The name of the trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-name

getBranches

@Stability(Stable)
@Nullable
default List<String> getBranches()

The branches to be included in the trigger configuration.

If you specify an empty array, the trigger applies to all branches.

Although no content is required in the array, you must include the array itself.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-branches

getCustomData

@Stability(Stable)
@Nullable
default String getCustomData()

Any custom data associated with the trigger to be included in the information sent to the target of the trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-customdata

builder

@Stability(Stable)
static CfnRepository.RepositoryTriggerProperty.Builder builder()

Returns:

a CfnRepository.RepositoryTriggerProperty.Builder of CfnRepository.RepositoryTriggerProperty