aws-sdk-amplify 1.111.0

AWS SDK for AWS Amplify
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>The request structure for the update domain association request.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateDomainAssociationInput {
    /// <p>The unique ID for an Amplify app.</p>
    pub app_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the domain.</p>
    pub domain_name: ::std::option::Option<::std::string::String>,
    /// <p>Enables the automated creation of subdomains for branches.</p>
    pub enable_auto_sub_domain: ::std::option::Option<bool>,
    /// <p>Describes the settings for the subdomain.</p>
    pub sub_domain_settings: ::std::option::Option<::std::vec::Vec<crate::types::SubDomainSetting>>,
    /// <p>Sets the branch patterns for automatic subdomain creation.</p>
    pub auto_sub_domain_creation_patterns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p>
    pub auto_sub_domain_iam_role: ::std::option::Option<::std::string::String>,
    /// <p>The type of SSL/TLS certificate to use for your custom domain.</p>
    pub certificate_settings: ::std::option::Option<crate::types::CertificateSettings>,
}
impl UpdateDomainAssociationInput {
    /// <p>The unique ID for an Amplify app.</p>
    pub fn app_id(&self) -> ::std::option::Option<&str> {
        self.app_id.as_deref()
    }
    /// <p>The name of the domain.</p>
    pub fn domain_name(&self) -> ::std::option::Option<&str> {
        self.domain_name.as_deref()
    }
    /// <p>Enables the automated creation of subdomains for branches.</p>
    pub fn enable_auto_sub_domain(&self) -> ::std::option::Option<bool> {
        self.enable_auto_sub_domain
    }
    /// <p>Describes the settings for the subdomain.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.sub_domain_settings.is_none()`.
    pub fn sub_domain_settings(&self) -> &[crate::types::SubDomainSetting] {
        self.sub_domain_settings.as_deref().unwrap_or_default()
    }
    /// <p>Sets the branch patterns for automatic subdomain creation.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.auto_sub_domain_creation_patterns.is_none()`.
    pub fn auto_sub_domain_creation_patterns(&self) -> &[::std::string::String] {
        self.auto_sub_domain_creation_patterns.as_deref().unwrap_or_default()
    }
    /// <p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p>
    pub fn auto_sub_domain_iam_role(&self) -> ::std::option::Option<&str> {
        self.auto_sub_domain_iam_role.as_deref()
    }
    /// <p>The type of SSL/TLS certificate to use for your custom domain.</p>
    pub fn certificate_settings(&self) -> ::std::option::Option<&crate::types::CertificateSettings> {
        self.certificate_settings.as_ref()
    }
}
impl UpdateDomainAssociationInput {
    /// Creates a new builder-style object to manufacture [`UpdateDomainAssociationInput`](crate::operation::update_domain_association::UpdateDomainAssociationInput).
    pub fn builder() -> crate::operation::update_domain_association::builders::UpdateDomainAssociationInputBuilder {
        crate::operation::update_domain_association::builders::UpdateDomainAssociationInputBuilder::default()
    }
}

/// A builder for [`UpdateDomainAssociationInput`](crate::operation::update_domain_association::UpdateDomainAssociationInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateDomainAssociationInputBuilder {
    pub(crate) app_id: ::std::option::Option<::std::string::String>,
    pub(crate) domain_name: ::std::option::Option<::std::string::String>,
    pub(crate) enable_auto_sub_domain: ::std::option::Option<bool>,
    pub(crate) sub_domain_settings: ::std::option::Option<::std::vec::Vec<crate::types::SubDomainSetting>>,
    pub(crate) auto_sub_domain_creation_patterns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) auto_sub_domain_iam_role: ::std::option::Option<::std::string::String>,
    pub(crate) certificate_settings: ::std::option::Option<crate::types::CertificateSettings>,
}
impl UpdateDomainAssociationInputBuilder {
    /// <p>The unique ID for an Amplify app.</p>
    /// This field is required.
    pub fn app_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.app_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique ID for an Amplify app.</p>
    pub fn set_app_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.app_id = input;
        self
    }
    /// <p>The unique ID for an Amplify app.</p>
    pub fn get_app_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.app_id
    }
    /// <p>The name of the domain.</p>
    /// This field is required.
    pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the domain.</p>
    pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_name = input;
        self
    }
    /// <p>The name of the domain.</p>
    pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_name
    }
    /// <p>Enables the automated creation of subdomains for branches.</p>
    pub fn enable_auto_sub_domain(mut self, input: bool) -> Self {
        self.enable_auto_sub_domain = ::std::option::Option::Some(input);
        self
    }
    /// <p>Enables the automated creation of subdomains for branches.</p>
    pub fn set_enable_auto_sub_domain(mut self, input: ::std::option::Option<bool>) -> Self {
        self.enable_auto_sub_domain = input;
        self
    }
    /// <p>Enables the automated creation of subdomains for branches.</p>
    pub fn get_enable_auto_sub_domain(&self) -> &::std::option::Option<bool> {
        &self.enable_auto_sub_domain
    }
    /// Appends an item to `sub_domain_settings`.
    ///
    /// To override the contents of this collection use [`set_sub_domain_settings`](Self::set_sub_domain_settings).
    ///
    /// <p>Describes the settings for the subdomain.</p>
    pub fn sub_domain_settings(mut self, input: crate::types::SubDomainSetting) -> Self {
        let mut v = self.sub_domain_settings.unwrap_or_default();
        v.push(input);
        self.sub_domain_settings = ::std::option::Option::Some(v);
        self
    }
    /// <p>Describes the settings for the subdomain.</p>
    pub fn set_sub_domain_settings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SubDomainSetting>>) -> Self {
        self.sub_domain_settings = input;
        self
    }
    /// <p>Describes the settings for the subdomain.</p>
    pub fn get_sub_domain_settings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SubDomainSetting>> {
        &self.sub_domain_settings
    }
    /// Appends an item to `auto_sub_domain_creation_patterns`.
    ///
    /// To override the contents of this collection use [`set_auto_sub_domain_creation_patterns`](Self::set_auto_sub_domain_creation_patterns).
    ///
    /// <p>Sets the branch patterns for automatic subdomain creation.</p>
    pub fn auto_sub_domain_creation_patterns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.auto_sub_domain_creation_patterns.unwrap_or_default();
        v.push(input.into());
        self.auto_sub_domain_creation_patterns = ::std::option::Option::Some(v);
        self
    }
    /// <p>Sets the branch patterns for automatic subdomain creation.</p>
    pub fn set_auto_sub_domain_creation_patterns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.auto_sub_domain_creation_patterns = input;
        self
    }
    /// <p>Sets the branch patterns for automatic subdomain creation.</p>
    pub fn get_auto_sub_domain_creation_patterns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.auto_sub_domain_creation_patterns
    }
    /// <p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p>
    pub fn auto_sub_domain_iam_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.auto_sub_domain_iam_role = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p>
    pub fn set_auto_sub_domain_iam_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.auto_sub_domain_iam_role = input;
        self
    }
    /// <p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p>
    pub fn get_auto_sub_domain_iam_role(&self) -> &::std::option::Option<::std::string::String> {
        &self.auto_sub_domain_iam_role
    }
    /// <p>The type of SSL/TLS certificate to use for your custom domain.</p>
    pub fn certificate_settings(mut self, input: crate::types::CertificateSettings) -> Self {
        self.certificate_settings = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of SSL/TLS certificate to use for your custom domain.</p>
    pub fn set_certificate_settings(mut self, input: ::std::option::Option<crate::types::CertificateSettings>) -> Self {
        self.certificate_settings = input;
        self
    }
    /// <p>The type of SSL/TLS certificate to use for your custom domain.</p>
    pub fn get_certificate_settings(&self) -> &::std::option::Option<crate::types::CertificateSettings> {
        &self.certificate_settings
    }
    /// Consumes the builder and constructs a [`UpdateDomainAssociationInput`](crate::operation::update_domain_association::UpdateDomainAssociationInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<
        crate::operation::update_domain_association::UpdateDomainAssociationInput,
        ::aws_smithy_types::error::operation::BuildError,
    > {
        ::std::result::Result::Ok(crate::operation::update_domain_association::UpdateDomainAssociationInput {
            app_id: self.app_id,
            domain_name: self.domain_name,
            enable_auto_sub_domain: self.enable_auto_sub_domain,
            sub_domain_settings: self.sub_domain_settings,
            auto_sub_domain_creation_patterns: self.auto_sub_domain_creation_patterns,
            auto_sub_domain_iam_role: self.auto_sub_domain_iam_role,
            certificate_settings: self.certificate_settings,
        })
    }
}