Package software.amazon.awscdk.cfnpropertymixins.services.codepipeline

Interface CfnWebhookPropsMixin.WebhookAuthConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnWebhookPropsMixin

@Stability(Stable)
public static interface CfnWebhookPropsMixin.WebhookAuthConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The authentication applied to incoming webhook trigger requests.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.codepipeline.*;
 WebhookAuthConfigurationProperty webhookAuthConfigurationProperty = WebhookAuthConfigurationProperty.builder()
         .allowedIpRange("allowedIpRange")
         .secretToken("secretToken")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Builder	A builder for CfnWebhookPropsMixin.WebhookAuthConfigurationProperty
static final class	CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Jsii$Proxy	An implementation for CfnWebhookPropsMixin.WebhookAuthConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Builder	builder()
default String	getAllowedIpRange()	The property used to configure acceptance of webhooks in an IP address range.
default String	getSecretToken()	The property used to configure GitHub authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedIpRange

@Stability(Stable)
@Nullable
default String getAllowedIpRange()

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.

See Also:

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

getSecretToken

@Stability(Stable)
@Nullable
default String getSecretToken()

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.

See Also:

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

builder

@Stability(Stable)
static CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Builder builder()

Returns:

a CfnWebhookPropsMixin.WebhookAuthConfigurationProperty.Builder of CfnWebhookPropsMixin.WebhookAuthConfigurationProperty