AWS CodePipeline Webhook
This page shows how to write Terraform and CloudFormation for CodePipeline Webhook and write them securely.
aws_codepipeline_webhook (Terraform)
The Webhook in CodePipeline can be configured in Terraform with the resource name aws_codepipeline_webhook. The following sections describe 5 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_codepipeline_webhook" "codepipeline_webhook" {
authentication = "GITHUB_HMAC"
name = "codepipeline-webhook"
target_action = "Source"
target_pipeline = aws_codepipeline.static_web_pipeline.name
resource "aws_codepipeline_webhook" "codepipeline_webhook" {
authentication = "GITHUB_HMAC"
name = "codepipeline-webhook"
target_action = "Source"
target_pipeline = aws_codepipeline.codepipeline.name
resource "aws_codepipeline_webhook" "example" {
name = "example"
target_pipeline = aws_codepipeline.example.name
target_action = "Source"
authentication = "GITHUB_HMAC"
resource "aws_codepipeline_webhook" "example" {
name = "example"
target_pipeline = aws_codepipeline.example.name
target_action = "Source"
authentication = "GITHUB_HMAC"
resource "aws_codepipeline_webhook" "example" {
name = "example"
target_pipeline = aws_codepipeline.example.name
target_action = "Source"
authentication = "GITHUB_HMAC"
Parameters
-
authenticationrequired - string -
idoptional computed - string -
namerequired - string -
tagsoptional - map from string to string -
target_actionrequired - string -
target_pipelinerequired - string -
urloptional computed - string -
authentication_configurationlist block-
allowed_ip_rangeoptional - string -
secret_tokenoptional - string
-
-
filterset block-
json_pathrequired - string -
match_equalsrequired - string
-
Explanation in Terraform Registry
Provides a CodePipeline Webhook.
AWS::CodePipeline::Webhook (CloudFormation)
The Webhook in CodePipeline can be configured in CloudFormation with the resource name AWS::CodePipeline::Webhook. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
AuthenticationConfigurationrequired - WebhookAuthConfiguration -
Filtersrequired - List of WebhookFilterRule -
Authenticationrequired - String -
TargetPipelinerequired - String -
TargetActionrequired - String -
Nameoptional - String -
TargetPipelineVersionrequired - Integer -
RegisterWithThirdPartyoptional - Boolean
Explanation in CloudFormation Registry
The
AWS::CodePipeline::Webhookresource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Configure Your GitHub Pipelines to Use Webhooks for Change Detection in the AWS CodePipeline User Guide.We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see Using Dynamic References to Specify Template Values. Important When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials.
Frequently asked questions
What is AWS CodePipeline Webhook?
AWS CodePipeline Webhook is a resource for CodePipeline of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS CodePipeline Webhook?
For Terraform, the srinin01/cicdterraformpipeline, HemantTomar/pipe0 and mida-hub/hobby source code examples are useful. See the Terraform Example section for further details.
