You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeCommit::Types::RepositoryTrigger

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb

Overview

Note:

When making an API call, you may pass RepositoryTrigger data as a hash:

{
  name: "RepositoryTriggerName", # required
  destination_arn: "Arn", # required
  custom_data: "RepositoryTriggerCustomData",
  branches: ["BranchName"],
  events: ["all"], # required, accepts all, updateReference, createReference, deleteReference
}

Information about a trigger for a repository.

Instance Attribute Summary collapse

Instance Attribute Details

#branchesArray<String>

The branches that will be included in the trigger configuration. If you specify an empty array, the trigger will apply to all branches.

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

Returns:

  • (Array<String>)


2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2260

class RepositoryTrigger < Struct.new(
  :name,
  :destination_arn,
  :custom_data,
  :branches,
  :events)
  include Aws::Structure
end

#custom_dataString

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

Returns:

  • (String)


2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2260

class RepositoryTrigger < Struct.new(
  :name,
  :destination_arn,
  :custom_data,
  :branches,
  :events)
  include Aws::Structure
end

#destination_arnString

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

Returns:

  • (String)


2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2260

class RepositoryTrigger < Struct.new(
  :name,
  :destination_arn,
  :custom_data,
  :branches,
  :events)
  include Aws::Structure
end

#eventsArray<String>

The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS).

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

Returns:

  • (Array<String>)


2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2260

class RepositoryTrigger < Struct.new(
  :name,
  :destination_arn,
  :custom_data,
  :branches,
  :events)
  include Aws::Structure
end

#nameString

The name of the trigger.

Returns:

  • (String)


2260
2261
2262
2263
2264
2265
2266
2267
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2260

class RepositoryTrigger < Struct.new(
  :name,
  :destination_arn,
  :custom_data,
  :branches,
  :events)
  include Aws::Structure
end