Skip to content

WebhookAuthConfiguration

Source code in docs_src/capo_codepipeline/types/webhook_auth_configuration.py 
12
13
14
15
16
17
18
19
20
class WebhookAuthConfiguration(TypedDict, closed=True):
    allowed_ip_range: NotRequired[
        "capo_codepipeline.types.webhook_auth_configuration_allowed_ip_range.WebhookAuthConfigurationAllowedIPRange"
    ]
    """<p>The property used to configure acceptance of webhooks in an IP address range. For IP, only the <code>AllowedIPRange</code> property must be set. This property must be set to a valid CIDR range.</p>"""
    secret_token: NotRequired[
        "capo_codepipeline.types.webhook_auth_configuration_secret_token.WebhookAuthConfigurationSecretToken"
    ]
    """<p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the <code>SecretToken</code> property must be set.</p> <important> <p>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.</p> </important> <note> <p>If a secret token was provided, it will be redacted in the response.</p> </note>"""

allowed_ip_range instance-attribute 

allowed_ip_range: NotRequired[WebhookAuthConfigurationAllowedIPRange]

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.

secret_token instance-attribute 

secret_token: NotRequired[WebhookAuthConfigurationSecretToken]

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.