Struct aws_sdk_codepipeline::types::WebhookDefinition

#[non_exhaustive]
pub struct WebhookDefinition {
    pub name: String,
    pub target_pipeline: String,
    pub target_action: String,
    pub filters: Vec<WebhookFilterRule>,
    pub authentication: WebhookAuthenticationType,
    pub authentication_configuration: Option<WebhookAuthConfiguration>,
}

Represents information about a webhook and its definition.

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.

name: String

The name of the webhook.

target_pipeline: String

The name of the pipeline you want to connect to the webhook.

target_action: String

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

filters: Vec<WebhookFilterRule>

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

authentication: WebhookAuthenticationType

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

• For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

authentication_configuration: Option<WebhookAuthConfiguration>

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Implementations

impl WebhookDefinition

pub fn name(&self) -> &str

The name of the webhook.

pub fn target_pipeline(&self) -> &str

The name of the pipeline you want to connect to the webhook.

pub fn target_action(&self) -> &str

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

pub fn filters(&self) -> &[WebhookFilterRule]

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

pub fn authentication(&self) -> &WebhookAuthenticationType

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

• For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

pub fn authentication_configuration(&self) -> Option<&WebhookAuthConfiguration>

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

impl WebhookDefinition

pub fn builder() -> WebhookDefinitionBuilder

Creates a new builder-style object to manufacture WebhookDefinition.

Trait Implementations

impl Clone for WebhookDefinition

fn clone(&self) -> WebhookDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookDefinition

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

Formats the value using the given formatter.

impl PartialEq for WebhookDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for WebhookDefinition