Struct WebhookAuthConfiguration

#[non_exhaustive]
pub struct WebhookAuthConfiguration {
    pub allowed_ip_range: Option<String>,
    pub secret_token: Option<String>,
}

The authentication applied to incoming webhook trigger requests.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allowed_ip_range: Option<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.

secret_token: Option<String>

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.

Implementations

impl WebhookAuthConfiguration

pub fn allowed_ip_range(&self) -> Option<&str>

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.

pub fn secret_token(&self) -> Option<&str>

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.

impl WebhookAuthConfiguration

pub fn builder() -> WebhookAuthConfigurationBuilder

Creates a new builder-style object to manufacture WebhookAuthConfiguration.

Trait Implementations

impl Clone for WebhookAuthConfiguration

fn clone(&self) -> WebhookAuthConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebhookAuthConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WebhookAuthConfiguration

fn eq(&self, other: &WebhookAuthConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WebhookAuthConfiguration