2.184.1

interface RepositoryTriggerProperty

LanguageType name
.NETAmazon.CDK.AWS.CodeCommit.CfnRepository.RepositoryTriggerProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodecommit#CfnRepository_RepositoryTriggerProperty
Javasoftware.amazon.awscdk.services.codecommit.CfnRepository.RepositoryTriggerProperty
Pythonaws_cdk.aws_codecommit.CfnRepository.RepositoryTriggerProperty
TypeScript aws-cdk-lib » aws_codecommit » CfnRepository » RepositoryTriggerProperty

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codecommit as codecommit } from 'aws-cdk-lib';
const repositoryTriggerProperty: codecommit.CfnRepository.RepositoryTriggerProperty = {
  destinationArn: 'destinationArn',
  events: ['events'],
  name: 'name',

  // the properties below are optional
  branches: ['branches'],
  customData: 'customData',
};

Properties

NameTypeDescription
destinationArnstringThe ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).
eventsstring[]The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.
namestringThe name of the trigger.
branches?string[]The branches to be included in the trigger configuration.
customData?stringAny custom data associated with the trigger to be included in the information sent to the target of the trigger.

destinationArn

Type: string

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

events

Type: string[]

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

name

Type: string

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

branches?

Type: string[] (optional)

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

customData?

Type: string (optional)

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

← PreviousNext →