aws-cdk-lib.aws_codepipeline.CfnWebhook.WebhookAuthConfigurationProperty

WebhookAuthConfigurationProperty Struct

The authentication applied to incoming webhook trigger requests.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const webhookAuthConfigurationProperty: codepipeline.CfnWebhook.WebhookAuthConfigurationProperty = {
  allowedIpRange: 'allowedIpRange',
  secretToken: 'secretToken',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codepipeline as codepipeline

webhook_auth_configuration_property = codepipeline.CfnWebhook.WebhookAuthConfigurationProperty(
    allowed_ip_range="allowedIpRange",
    secret_token="secretToken"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codepipeline.*;

WebhookAuthConfigurationProperty webhookAuthConfigurationProperty = WebhookAuthConfigurationProperty.builder()
        .allowedIpRange("allowedIpRange")
        .secretToken("secretToken")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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 webhookAuthConfigurationProperty = new WebhookAuthConfigurationProperty {
    AllowedIpRange = "allowedIpRange",
    SecretToken = "secretToken"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

webhookAuthConfigurationProperty := &WebhookAuthConfigurationProperty{
	AllowedIpRange: jsii.String("allowedIpRange"),
	SecretToken: jsii.String("secretToken"),
}

Properties

allowedIpRange?optionalstringallowed_ip_range?optionalstrallowedIpRange?optionalStringAllowedIpRange?optionalstringAllowedIpRange?optional*string#

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.

secretToken?optionalstringsecret_token?optionalstrsecretToken?optionalStringSecretToken?optionalstringSecretToken?optional*string#

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

notes

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.