Class CfnWebhookProps

Properties for defining a CfnWebhook.

Inheritance

object

CfnWebhookProps

Implements

ICfnWebhookProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWebhookProps : ICfnWebhookProps

Syntax (vb)

Public Class CfnWebhookProps Implements ICfnWebhookProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodePipeline;

             var cfnWebhookProps = new CfnWebhookProps {
                 Authentication = "authentication",
                 AuthenticationConfiguration = new WebhookAuthConfigurationProperty {
                     AllowedIpRange = "allowedIpRange",
                     SecretToken = "secretToken"
                 },
                 Filters = new [] { new WebhookFilterRuleProperty {
                     JsonPath = "jsonPath",

                     // the properties below are optional
                     MatchEquals = "matchEquals"
                 } },
                 TargetAction = "targetAction",
                 TargetPipeline = "targetPipeline",

                 // the properties below are optional
                 Name = "name",
                 RegisterWithThirdParty = false,
                 TargetPipelineVersion = 123
             };

Synopsis

Constructors

CfnWebhookProps()

Properties for defining a CfnWebhook.

Properties

Authentication	Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
AuthenticationConfiguration	Properties that configure the authentication applied to incoming webhook trigger requests.
Filters	A list of rules applied to the body/payload sent in the POST request to a webhook URL.
Name	The name of the webhook.
RegisterWithThirdParty	Configures a connection between the webhook that was created and the external tool with events to be detected.
TargetAction	The name of the action in a pipeline you want to connect to the webhook.
TargetPipeline	The name of the pipeline you want to connect to the webhook.
TargetPipelineVersion	The version number of the pipeline to be connected to the trigger request.

Constructors

CfnWebhookProps()

Properties for defining a CfnWebhook.

public CfnWebhookProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodePipeline;

             var cfnWebhookProps = new CfnWebhookProps {
                 Authentication = "authentication",
                 AuthenticationConfiguration = new WebhookAuthConfigurationProperty {
                     AllowedIpRange = "allowedIpRange",
                     SecretToken = "secretToken"
                 },
                 Filters = new [] { new WebhookFilterRuleProperty {
                     JsonPath = "jsonPath",

                     // the properties below are optional
                     MatchEquals = "matchEquals"
                 } },
                 TargetAction = "targetAction",
                 TargetPipeline = "targetPipeline",

                 // the properties below are optional
                 Name = "name",
                 RegisterWithThirdParty = false,
                 TargetPipelineVersion = 123
             };

Properties

Authentication

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

public string Authentication { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication

AuthenticationConfiguration

Properties that configure the authentication applied to incoming webhook trigger requests.

public object AuthenticationConfiguration { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration

Filters

A list of rules applied to the body/payload sent in the POST request to a webhook URL.

public object Filters { get; set; }

Property Value

object

Remarks

All defined rules must pass for the request to be accepted and the pipeline started.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters

Name

The name of the webhook.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name

RegisterWithThirdParty

Configures a connection between the webhook that was created and the external tool with events to be detected.

public object? RegisterWithThirdParty { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty

TargetAction

The name of the action in a pipeline you want to connect to the webhook.

public string TargetAction { get; set; }

Property Value

string

Remarks

The action must be from the source (first) stage of the pipeline.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction

TargetPipeline

The name of the pipeline you want to connect to the webhook.

public string TargetPipeline { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline

TargetPipelineVersion

The version number of the pipeline to be connected to the trigger request.

public double? TargetPipelineVersion { get; set; }

Property Value

double?

Remarks

Required: Yes

Type: Integer

Update requires: No interruption

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion

Implements

ICfnWebhookProps