aws_codepipeline_webhook

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the webhook.

definition

Type: STRUCT
Provider name: definition
Description: The detail returned for each webhook, such as the webhook authentication type and filter rules.

• authentication
  Type: STRING
  Provider name: authentication
  Description: Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. If a secret token was provided, it will be redacted in the response.
  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
• authentication_configuration
  Type: STRUCT
  Provider name: authenticationConfiguration
  Description: Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
  
  • allowed_ip_range
    Type: STRING
    Provider name: AllowedIPRange
    Description: The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    
  • secret_token
    Type: STRING
    Provider name: SecretToken
    Description: The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set. When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. If a secret token was provided, it will be redacted in the response.
    
• filters
  Type: UNORDERED_LIST_STRUCT
  Provider name: filters
  Description: A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
  
  • json_path
    Type: STRING
    Provider name: jsonPath
    Description: A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
    
  • match_equals
    Type: STRING
    Provider name: matchEquals
    Description: The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is “refs/heads/{Branch}” and the target action has an action configuration property called “Branch” with a value of “main”, the MatchEquals value is evaluated as “refs/heads/main”. For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
    
• name
  Type: STRING
  Provider name: name
  Description: The name of the webhook.
  
• target_action
  Type: STRING
  Provider name: targetAction
  Description: The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
  
• target_pipeline
  Type: STRING
  Provider name: targetPipeline
  Description: The name of the pipeline you want to connect to the webhook.
  

error_code

Type: STRING
Provider name: errorCode
Description: The number code of the error.

error_message

Type: STRING
Provider name: errorMessage
Description: The text of the error message about the webhook.

last_triggered

Type: TIMESTAMP
Provider name: lastTriggered
Description: The date and time a webhook was last successfully triggered, in timestamp format.

tags

Type: UNORDERED_LIST_STRING

url

Type: STRING
Provider name: url
Description: A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.