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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*!
* Provides a more natural builder interface for constructing ResourceNames.
*
* The builder pattern allows for a more readable construction of ResourceNames, and in this case we
* provide a number of *verb* prefixes on *noun* constructors, so we have `in_region` as well as
* `and_region` which is more readable if it is preceded by `in_partition`. For the account id
* field there is `in_account`, `and_account`, `any_account`, and `owned_by`; all of these
* accomplish the same goal but allow for a choice that makes code easir to understand.
*
* # Resource-Specific Constructor Functions
*
* For the service-specific submodules (`iam`, `lambda`, `s3`, etc.) the functions are simply named
* for the noun that represents the resource type as described in the AWS documentation. As the
* partition in commonly left to default to "aws" there are also a set of `{noun}_in()` functions
* that take a partition, and corresponding `{noun}()` functions which do not.
*
* In some cases where an ResourceName may be dependent on another, for example an S3 object ResourceName might be
* constructed from an existing bucket ResourceName, additional `{noun}_from(other,...)` functions will
* be provided.
*
* Note that the final `build()` function will call `validate()`, and so it is possible to call
* intermediate functions with bad data which is only caught at build time.
*
* # Example
*
* The following shows the construction of an AWS versioned layer ResourceName.
*
* ```rust
* use aws_arn::builder::{ArnBuilder, ResourceBuilder};
* use aws_arn::{
*     AccountIdentifier, Identifier, IdentifierLike, ResourceIdentifier, ResourceName
* };
* use aws_arn::known::{Region, Service};
* use std::str::FromStr;
*
* let arn: ResourceName = ArnBuilder::service_id(Service::Lambda.into())
*     .resource(
*         ResourceBuilder::typed(Identifier::new_unchecked("layer"))
*             .resource_name(Identifier::new_unchecked("my-layer"))
*             .version(3)
*             .build_qualified_id(),
*     )
*     .in_region_id(Region::UsEast2.into())
*     .owned_by(AccountIdentifier::from_str("123456789012").unwrap())
*     .into();
* println!("ResourceName: '{}'", arn);
* ```
*
* This should print `ResourceName: 'arn:aws:lambda:us-east-2:123456789012:layer:my-layer:3'`.
*/

use crate::known::{Partition, Region, Service};
use crate::{AccountIdentifier, Identifier, IdentifierLike, ResourceIdentifier, ResourceName};

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

///
/// Builder type for an AWS `ResourceName`.
///
#[derive(Clone, Debug)]
pub struct ArnBuilder {
    arn: ResourceName,
}

///
/// Builder type for a `ResourceIdentifier`.
///
/// The methods `build_resource_path` and `build_qualified_id` are used to construct identifiers
/// with either the '/' or ':' separator between the collected components.
///
#[derive(Clone, Debug, Default)]
pub struct ResourceBuilder {
    resource: Vec<ResourceIdentifier>,
}

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl From<ArnBuilder> for ResourceName {
    fn from(v: ArnBuilder) -> Self {
        v.arn
    }
}

impl From<&mut ArnBuilder> for ResourceName {
    fn from(v: &mut ArnBuilder) -> Self {
        v.arn.clone()
    }
}

impl ArnBuilder {
    /// Construct an ResourceName for the specified `service`.
    pub fn service(service: Service) -> Self {
        Self::service_id(service.into())
    }

    /// Construct an ResourceName for the specified `service`.
    pub fn service_id(service: Identifier) -> Self {
        Self {
            arn: ResourceName {
                partition: None,
                service,
                region: None,
                account_id: None,
                resource: ResourceIdentifier::default(),
            },
        }
    }

    /// Set a specific `partition` for this ResourceName.
    pub fn in_partition(&mut self, partition: Partition) -> &mut Self {
        self.in_partition_id(partition.into())
    }

    /// Set a specific `partition` for this ResourceName.
    pub fn in_partition_id(&mut self, partition: Identifier) -> &mut Self {
        self.arn.partition = Some(partition);
        self
    }

    /// Set a specific `partition` for this ResourceName.
    pub fn in_default_partition(&mut self) -> &mut Self {
        self.arn.partition = Some(Partition::default().into());
        self
    }

    /// Set a specific `partition` for this ResourceName.
    pub fn in_any_partition(&mut self) -> &mut Self {
        self.arn.partition = None;
        self
    }

    /// Set a specific `region` for this ResourceName.
    pub fn in_region(&mut self, region: Region) -> &mut Self {
        self.in_region_id(region.into())
    }

    /// Set a specific `region` for this ResourceName.
    pub fn in_region_id(&mut self, region: Identifier) -> &mut Self {
        self.arn.region = Some(region);
        self
    }

    /// Set a specific `region` for this ResourceName.
    pub fn and_region(&mut self, region: Region) -> &mut Self {
        self.in_region_id(region.into())
    }

    /// Set a specific `region` for this ResourceName.
    pub fn and_region_id(&mut self, region: Identifier) -> &mut Self {
        self.in_region_id(region)
    }

    /// Set `region` to a wildcard for this ResourceName.
    pub fn in_any_region(&mut self) -> &mut Self {
        self.in_region_id(Identifier::default())
    }

    /// Set a specific `account` for this ResourceName.
    pub fn in_account(&mut self, account: AccountIdentifier) -> &mut Self {
        self.arn.account_id = Some(account);
        self
    }

    /// Set a specific `account` for this ResourceName.
    pub fn and_account(&mut self, account: AccountIdentifier) -> &mut Self {
        self.in_account(account)
    }

    /// Set a specific `account` for this ResourceName.
    pub fn owned_by(&mut self, account: AccountIdentifier) -> &mut Self {
        self.in_account(account)
    }

    /// Set `account` to a wildcard for this ResourceName.
    pub fn in_any_account(&mut self) -> &mut Self {
        self.in_account(AccountIdentifier::default())
    }

    /// Set a specific `resource` for this ResourceName.
    pub fn resource(&mut self, resource: ResourceIdentifier) -> &mut Self {
        self.arn.resource = resource;
        self
    }

    /// Set a specific `resource` for this ResourceName.
    pub fn is(&mut self, resource: ResourceIdentifier) -> &mut Self {
        self.resource(resource)
    }

    /// Set a specific `resource` for this ResourceName.
    pub fn a(&mut self, resource: ResourceIdentifier) -> &mut Self {
        self.resource(resource)
    }

    /// Set `resource` to a wildcard for this ResourceName.
    pub fn any_resource(&mut self) -> &mut Self {
        self.arn.resource = ResourceIdentifier::any();
        self
    }

    /// Set `resource` to a wildcard for this ResourceName.
    pub fn for_any_resource(&mut self) -> &mut Self {
        self.any_resource()
    }
}

// ------------------------------------------------------------------------------------------------

impl From<ResourceIdentifier> for ResourceBuilder {
    fn from(v: ResourceIdentifier) -> Self {
        Self { resource: vec![v] }
    }
}

impl From<Identifier> for ResourceBuilder {
    fn from(v: Identifier) -> Self {
        Self {
            resource: vec![v.into()],
        }
    }
}

impl ResourceBuilder {
    /// Construct a new resource builder containing only the provided identifier.
    pub fn named(id: Identifier) -> Self {
        Self {
            resource: vec![id.into()],
        }
    }

    /// Construct a new resource builder containing only the provided identifier.
    pub fn typed(id: Identifier) -> Self {
        Self {
            resource: vec![id.into()],
        }
    }

    /// Add the provided `ResourceIdentifier` to the inner list of components.
    pub fn add(&mut self, id: ResourceIdentifier) -> &mut Self {
        self.resource.push(id);
        self
    }

    /// Add the provided `ResourceIdentifier` to the inner list of components.
    pub fn qualified_name(&mut self, id: ResourceIdentifier) -> &mut Self {
        self.resource.push(id);
        self
    }

    /// Add the provided `ResourceIdentifier` to the inner list of components.
    pub fn resource_path(&mut self, id: ResourceIdentifier) -> &mut Self {
        self.resource.push(id);
        self
    }

    /// Add the provided `Identifier` to the inner list of components.
    pub fn type_name(&mut self, id: Identifier) -> &mut Self {
        self.resource.push(id.into());
        self
    }

    /// Add the provided `Identifier` to the inner list of components.
    pub fn resource_name(&mut self, id: Identifier) -> &mut Self {
        self.resource.push(id.into());
        self
    }

    /// Add the provided `Identifier` to the inner list of components.
    pub fn sub_resource_name(&mut self, id: Identifier) -> &mut Self {
        self.resource.push(id.into());
        self
    }

    /// Add the provided integer version number to the inner list of components.
    pub fn version(&mut self, v: u32) -> &mut Self {
        self.resource
            .push(Identifier::new_unchecked(&v.to_string()).into());
        self
    }

    /// Return the iner list of components as a resource identifier path.
    pub fn build_resource_path(&mut self) -> ResourceIdentifier {
        ResourceIdentifier::from_path(&self.resource)
    }

    /// Return the iner list of components as a qualified resource identifier.
    pub fn build_qualified_id(&mut self) -> ResourceIdentifier {
        ResourceIdentifier::from_qualified(&self.resource)
    }
}

// ------------------------------------------------------------------------------------------------
// Modules
// ------------------------------------------------------------------------------------------------

pub mod cognito;

pub mod iam;

pub mod lambda;

pub mod s3;