Class CfnWebhookPropsMixin.WebhookAuthConfigurationProperty

The authentication applied to incoming webhook trigger requests.

Inheritance
object
CfnWebhookPropsMixin.WebhookAuthConfigurationProperty
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.CodePipeline.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnWebhookPropsMixin.WebhookAuthConfigurationProperty : CfnWebhookPropsMixin.IWebhookAuthConfigurationProperty
Syntax (vb)
Public Class CfnWebhookPropsMixin.WebhookAuthConfigurationProperty Implements CfnWebhookPropsMixin.IWebhookAuthConfigurationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.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.Mixins.Preview.AWS.CodePipeline.Mixins;

             var webhookAuthConfigurationProperty = new WebhookAuthConfigurationProperty {
                 AllowedIpRange = "allowedIpRange",
                 SecretToken = "secretToken"
             };

Synopsis

Constructors

WebhookAuthConfigurationProperty()

The authentication applied to incoming webhook trigger requests.

Properties

AllowedIpRange

The property used to configure acceptance of webhooks in an IP address range.
SecretToken

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

Constructors

WebhookAuthConfigurationProperty()

The authentication applied to incoming webhook trigger requests.

public WebhookAuthConfigurationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.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.Mixins.Preview.AWS.CodePipeline.Mixins;

             var webhookAuthConfigurationProperty = new WebhookAuthConfigurationProperty {
                 AllowedIpRange = "allowedIpRange",
                 SecretToken = "secretToken"
             };

Properties

AllowedIpRange

The property used to configure acceptance of webhooks in an IP address range.

public string? AllowedIpRange { get; set; }
Property Value

string

Remarks

For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange

SecretToken

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

public string? SecretToken { 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-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken

Implements