View a markdown version of this page

AWS::DevOpsAgent::Trigger - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DevOpsAgent::Trigger

The AWS::DevOpsAgent::Trigger resource specifies a time-based trigger attached to an Agent Space that fires scheduled automation workflows within the AWS DevOps Agent service.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DevOpsAgent::Trigger",
  "Properties" : {
      "Action" : Json,
      "AgentSpaceId" : String,
      "Condition" : Condition,
      "Status" : String,
      "Type" : String
    }
}

YAML

Type: AWS::DevOpsAgent::Trigger
Properties:
  Action: Json
  AgentSpaceId: String
  Condition: 
    Condition
  Status: String
  Type: String

Properties

Action

The action to perform when the trigger fires. A JSON object specifying the action type and task configuration.

Required: Yes

Type: Json

Update requires: Replacement

AgentSpaceId

The unique identifier of the parent Agent Space.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Condition

The condition that determines when the trigger fires.

Required: Yes

Type: Condition

Update requires: Replacement

Status

The status of the trigger. Active triggers fire on schedule; Inactive triggers are paused.

Required: No

Type: String

Allowed values: Active | Inactive

Update requires: No interruption

Type

The type of trigger. Currently only TIME_BASED is supported.

Required: Yes

Type: String

Allowed values: TIME_BASED

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the TriggerId.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the trigger.

CreatedAt

The timestamp when the trigger was created.

TriggerId

The unique identifier of the trigger.

UpdatedAt

The timestamp when the trigger was last updated.