Struct aws_sdk_codepipeline::types::builders::WebhookDefinitionBuilder

#[non_exhaustive]
pub struct WebhookDefinitionBuilder { /* private fields */ }

A builder for WebhookDefinition.

Implementations

impl WebhookDefinitionBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the webhook.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the webhook.

pub fn get_name(&self) -> &Option<String>

The name of the webhook.

pub fn target_pipeline(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_target_pipeline(self, input: Option<String>) -> Self

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

pub fn get_target_pipeline(&self) -> &Option<String>

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

pub fn target_action(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_target_action(self, input: Option<String>) -> Self

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 get_target_action(&self) -> &Option<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.

pub fn filters(self, input: WebhookFilterRule) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

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 set_filters(self, input: Option<Vec<WebhookFilterRule>>) -> Self

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 get_filters(&self) -> &Option<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.

pub fn authentication(self, input: WebhookAuthenticationType) -> Self

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.

This field is required.

pub fn set_authentication( self, input: Option<WebhookAuthenticationType> ) -> Self

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 get_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.

pub fn authentication_configuration( self, input: WebhookAuthConfiguration ) -> Self

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.

This field is required.

pub fn set_authentication_configuration( self, input: Option<WebhookAuthConfiguration> ) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<WebhookDefinition, BuildError>

Consumes the builder and constructs a WebhookDefinition. This method will fail if any of the following fields are not set:

• name
• target_pipeline
• target_action
• filters
• authentication

Trait Implementations

impl Clone for WebhookDefinitionBuilder

fn clone(&self) -> WebhookDefinitionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookDefinitionBuilder

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

Formats the value using the given formatter.

impl Default for WebhookDefinitionBuilder

fn default() -> WebhookDefinitionBuilder

Returns the “default value” for a type.

impl PartialEq for WebhookDefinitionBuilder

fn eq(&self, other: &WebhookDefinitionBuilder) -> 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 WebhookDefinitionBuilder