aws-arn 0.1.1

Provides types, builders, and other helpers to manipulate AWS Amazon Resource Name (ARN) strings
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

/*!
Provides a set of simple helper functions to make ARNs for the S3 service.

These resource definitions ae take from the AWS
[documentation]( https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies)
*/

use crate::builder::{ArnBuilder, ResourceBuilder};
use crate::{ArnError, Resource, ARN};

// ------------------------------------------------------------------------------------------------
// Public Functions
// ------------------------------------------------------------------------------------------------

///
/// The service name portion of the ARN.
///
pub const SERVICE_NAME: &str = "s3";

///
/// `arn:${Partition}:s3:::${BucketName}`
///
pub fn bucket_in(partition: &str, bucket_name: &str) -> Result<ARN, ArnError> {
    ArnBuilder::new(SERVICE_NAME)
        .in_partition(partition)
        .is(ResourceBuilder::new(bucket_name).build()?)
        .build()
}

///
/// `arn:aws:s3:::${BucketName}`
///
pub fn bucket(bucket_name: &str) -> Result<ARN, ArnError> {
    bucket_in("aws", bucket_name)
}

///
/// `arn:${Partition}:s3:::${BucketName}/${ObjectName}`
///
pub fn object_in(partition: &str, bucket_name: &str, object_name: &str) -> Result<ARN, ArnError> {
    ArnBuilder::new(SERVICE_NAME)
        .in_partition(partition)
        .is(ResourceBuilder::new(&format!("{}/{}", bucket_name, object_name)).build()?)
        .build()
}

///
/// `arn:$aws:s3:::${BucketName}/${ObjectName}`
///
pub fn object(bucket_name: &str, object_name: &str) -> Result<ARN, ArnError> {
    object_in("aws", bucket_name, object_name)
}

///
/// `arn:$aws:s3:::${BucketName}/${ObjectName}`
///
/// This function will panic if `bucket` is not an ARN for an S3 bucket.
///
pub fn object_from(bucket: &ARN, object_name: &str) -> Result<ARN, ArnError> {
    if bucket.service != SERVICE_NAME.to_string() {
        panic!("You can't make an S3 object from a {} ARN.", bucket.service);
    }
    if let Resource::Id(id) = &bucket.resource {
        Ok(ARN {
            resource: ResourceBuilder::new(&format!("{}/{}", id, object_name)).build()?,
            ..bucket.clone()
        })
    } else {
        Err(ArnError::InvalidResource)
    }
}

///
/// `arn:${Partition}:s3:${Region}:${Account}:job/${JobId}`
///
pub fn job_in(partition: &str, region: &str, account: &str, job_id: &str) -> Result<ARN, ArnError> {
    ArnBuilder::new(SERVICE_NAME)
        .in_partition(partition)
        .in_region(region)
        .owned_by(account)
        .is(ResourceBuilder::new(job_id).build()?)
        .build()
}

///
/// `arn:aws:s3:${Region}:${Account}:job/${JobId}`
///
pub fn job(region: &str, account: &str, job_id: &str) -> Result<ARN, ArnError> {
    job_in("aws", region, account, job_id)
}