aws_sdk_codepipeline/operation/put_webhook/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_webhook::_put_webhook_output::PutWebhookOutputBuilder;
3
4pub use crate::operation::put_webhook::_put_webhook_input::PutWebhookInputBuilder;
5
6impl crate::operation::put_webhook::builders::PutWebhookInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::put_webhook::PutWebhookOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::put_webhook::PutWebhookError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.put_webhook();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PutWebhook`.
24///
25/// <p>Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.</p><important>
26/// <p>When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.</p>
27/// </important> <note>
28/// <p>If a secret token was provided, it will be redacted in the response.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct PutWebhookFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::put_webhook::builders::PutWebhookInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::put_webhook::PutWebhookOutput,
39        crate::operation::put_webhook::PutWebhookError,
40    > for PutWebhookFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::put_webhook::PutWebhookOutput,
48            crate::operation::put_webhook::PutWebhookError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl PutWebhookFluentBuilder {
55    /// Creates a new `PutWebhookFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the PutWebhook as a reference.
64    pub fn as_input(&self) -> &crate::operation::put_webhook::builders::PutWebhookInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::put_webhook::PutWebhookOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::put_webhook::PutWebhookError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::put_webhook::PutWebhook::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::put_webhook::PutWebhook::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::put_webhook::PutWebhookOutput,
101        crate::operation::put_webhook::PutWebhookError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.</p>
116    pub fn webhook(mut self, input: crate::types::WebhookDefinition) -> Self {
117        self.inner = self.inner.webhook(input);
118        self
119    }
120    /// <p>The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.</p>
121    pub fn set_webhook(mut self, input: ::std::option::Option<crate::types::WebhookDefinition>) -> Self {
122        self.inner = self.inner.set_webhook(input);
123        self
124    }
125    /// <p>The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.</p>
126    pub fn get_webhook(&self) -> &::std::option::Option<crate::types::WebhookDefinition> {
127        self.inner.get_webhook()
128    }
129    ///
130    /// Appends an item to `tags`.
131    ///
132    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
133    ///
134    /// <p>The tags for the webhook.</p>
135    pub fn tags(mut self, input: crate::types::Tag) -> Self {
136        self.inner = self.inner.tags(input);
137        self
138    }
139    /// <p>The tags for the webhook.</p>
140    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
141        self.inner = self.inner.set_tags(input);
142        self
143    }
144    /// <p>The tags for the webhook.</p>
145    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
146        self.inner.get_tags()
147    }
148}
aws_sdk_codepipeline/operation/put_webhook/builders.rs

aws_sdk_codepipeline/operation/put_webhook/
builders.rs
