Struct aws_sdk_codepipeline::model::WebhookDefinition
source · [−]#[non_exhaustive]pub struct WebhookDefinition { /* private fields */ }
Expand description
Represents information about a webhook and its definition.
Implementations
sourceimpl WebhookDefinition
impl WebhookDefinition
sourcepub fn target_pipeline(&self) -> Option<&str>
pub fn target_pipeline(&self) -> Option<&str>
The name of the pipeline you want to connect to the webhook.
sourcepub fn target_action(&self) -> Option<&str>
pub fn target_action(&self) -> Option<&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.
sourcepub fn filters(&self) -> Option<&[WebhookFilterRule]>
pub fn filters(&self) -> Option<&[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.
sourcepub fn authentication(&self) -> Option<&WebhookAuthenticationType>
pub fn authentication(&self) -> Option<&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.
sourcepub fn authentication_configuration(&self) -> Option<&WebhookAuthConfiguration>
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.
sourceimpl WebhookDefinition
impl WebhookDefinition
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture WebhookDefinition
.
Trait Implementations
sourceimpl Clone for WebhookDefinition
impl Clone for WebhookDefinition
sourcefn clone(&self) -> WebhookDefinition
fn clone(&self) -> WebhookDefinition
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more