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
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for WebhookDefinition
impl Debug for WebhookDefinition
sourceimpl PartialEq<WebhookDefinition> for WebhookDefinition
impl PartialEq<WebhookDefinition> for WebhookDefinition
sourcefn eq(&self, other: &WebhookDefinition) -> bool
fn eq(&self, other: &WebhookDefinition) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for WebhookDefinition
Auto Trait Implementations
impl RefUnwindSafe for WebhookDefinition
impl Send for WebhookDefinition
impl Sync for WebhookDefinition
impl Unpin for WebhookDefinition
impl UnwindSafe for WebhookDefinition
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more