Skip to main content

aws_sdk_codepipeline/types/
_action_type_settings.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Returns information about the settings for an action type.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct ActionTypeSettings {
7    /// <p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>
8    pub third_party_configuration_url: ::std::option::Option<::std::string::String>,
9    /// <p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.</p>
10    pub entity_url_template: ::std::option::Option<::std::string::String>,
11    /// <p>The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.</p>
12    pub execution_url_template: ::std::option::Option<::std::string::String>,
13    /// <p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>
14    pub revision_url_template: ::std::option::Option<::std::string::String>,
15}
16impl ActionTypeSettings {
17    /// <p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>
18    pub fn third_party_configuration_url(&self) -> ::std::option::Option<&str> {
19        self.third_party_configuration_url.as_deref()
20    }
21    /// <p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.</p>
22    pub fn entity_url_template(&self) -> ::std::option::Option<&str> {
23        self.entity_url_template.as_deref()
24    }
25    /// <p>The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.</p>
26    pub fn execution_url_template(&self) -> ::std::option::Option<&str> {
27        self.execution_url_template.as_deref()
28    }
29    /// <p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>
30    pub fn revision_url_template(&self) -> ::std::option::Option<&str> {
31        self.revision_url_template.as_deref()
32    }
33}
34impl ActionTypeSettings {
35    /// Creates a new builder-style object to manufacture [`ActionTypeSettings`](crate::types::ActionTypeSettings).
36    pub fn builder() -> crate::types::builders::ActionTypeSettingsBuilder {
37        crate::types::builders::ActionTypeSettingsBuilder::default()
38    }
39}
40
41/// A builder for [`ActionTypeSettings`](crate::types::ActionTypeSettings).
42#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
43#[non_exhaustive]
44pub struct ActionTypeSettingsBuilder {
45    pub(crate) third_party_configuration_url: ::std::option::Option<::std::string::String>,
46    pub(crate) entity_url_template: ::std::option::Option<::std::string::String>,
47    pub(crate) execution_url_template: ::std::option::Option<::std::string::String>,
48    pub(crate) revision_url_template: ::std::option::Option<::std::string::String>,
49}
50impl ActionTypeSettingsBuilder {
51    /// <p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>
52    pub fn third_party_configuration_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
53        self.third_party_configuration_url = ::std::option::Option::Some(input.into());
54        self
55    }
56    /// <p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>
57    pub fn set_third_party_configuration_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
58        self.third_party_configuration_url = input;
59        self
60    }
61    /// <p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>
62    pub fn get_third_party_configuration_url(&self) -> &::std::option::Option<::std::string::String> {
63        &self.third_party_configuration_url
64    }
65    /// <p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.</p>
66    pub fn entity_url_template(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
67        self.entity_url_template = ::std::option::Option::Some(input.into());
68        self
69    }
70    /// <p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.</p>
71    pub fn set_entity_url_template(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
72        self.entity_url_template = input;
73        self
74    }
75    /// <p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.</p>
76    pub fn get_entity_url_template(&self) -> &::std::option::Option<::std::string::String> {
77        &self.entity_url_template
78    }
79    /// <p>The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.</p>
80    pub fn execution_url_template(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
81        self.execution_url_template = ::std::option::Option::Some(input.into());
82        self
83    }
84    /// <p>The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.</p>
85    pub fn set_execution_url_template(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
86        self.execution_url_template = input;
87        self
88    }
89    /// <p>The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.</p>
90    pub fn get_execution_url_template(&self) -> &::std::option::Option<::std::string::String> {
91        &self.execution_url_template
92    }
93    /// <p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>
94    pub fn revision_url_template(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
95        self.revision_url_template = ::std::option::Option::Some(input.into());
96        self
97    }
98    /// <p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>
99    pub fn set_revision_url_template(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
100        self.revision_url_template = input;
101        self
102    }
103    /// <p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>
104    pub fn get_revision_url_template(&self) -> &::std::option::Option<::std::string::String> {
105        &self.revision_url_template
106    }
107    /// Consumes the builder and constructs a [`ActionTypeSettings`](crate::types::ActionTypeSettings).
108    pub fn build(self) -> crate::types::ActionTypeSettings {
109        crate::types::ActionTypeSettings {
110            third_party_configuration_url: self.third_party_configuration_url,
111            entity_url_template: self.entity_url_template,
112            execution_url_template: self.execution_url_template,
113            revision_url_template: self.revision_url_template,
114        }
115    }
116}