Struct aws_sdk_codepipeline::model::webhook_definition::Builder
source · [−]pub struct Builder { /* private fields */ }
Expand description
A builder for WebhookDefinition
.
Implementations
sourceimpl Builder
impl Builder
sourcepub fn target_pipeline(self, input: impl Into<String>) -> Self
pub fn target_pipeline(self, input: impl Into<String>) -> Self
The name of the pipeline you want to connect to the webhook.
sourcepub fn set_target_pipeline(self, input: Option<String>) -> Self
pub fn set_target_pipeline(self, input: Option<String>) -> Self
The name of the pipeline you want to connect to the webhook.
sourcepub fn target_action(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_target_action(self, input: Option<String>) -> Self
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.
sourcepub fn filters(self, input: WebhookFilterRule) -> Self
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.
sourcepub fn set_filters(self, input: Option<Vec<WebhookFilterRule>>) -> Self
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.
sourcepub fn authentication(self, input: WebhookAuthenticationType) -> Self
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.
sourcepub fn set_authentication(self, input: Option<WebhookAuthenticationType>) -> Self
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.
sourcepub fn authentication_configuration(
self,
input: WebhookAuthConfiguration
) -> Self
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.
sourcepub fn set_authentication_configuration(
self,
input: Option<WebhookAuthConfiguration>
) -> Self
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.
sourcepub fn build(self) -> WebhookDefinition
pub fn build(self) -> WebhookDefinition
Consumes the builder and constructs a WebhookDefinition
.