aws-arn 0.3.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
91
92
93
94
95
96
97
98

/*!
Provides a set of simple helper functions to make ResourceNames 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;
use crate::known::Partition;
use crate::known::Service::S3;
use crate::{AccountIdentifier, Identifier, ResourceIdentifier, ResourceName};

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

///
/// `arn:${Partition}:s3:::${BucketName}`
///
pub fn bucket_in(partition: Identifier, bucket_name: Identifier) -> ResourceName {
    ArnBuilder::service_id(S3.into())
        .in_partition_id(partition)
        .is(bucket_name.into())
        .into()
}

///
/// `arn:aws:s3:::${BucketName}`
///
pub fn bucket(bucket_name: Identifier) -> ResourceName {
    bucket_in(Partition::default().into(), bucket_name)
}

///
/// `arn:${Partition}:s3:::${BucketName}/${ObjectName}`
///
pub fn object_in(
    partition: Identifier,
    bucket_name: Identifier,
    object_name: Identifier,
) -> ResourceName {
    ArnBuilder::service_id(S3.into())
        .in_partition_id(partition)
        .is(ResourceIdentifier::from_id_path(&[
            bucket_name,
            object_name,
        ]))
        .into()
}

///
/// `arn:aws:s3:::${BucketName}/${ObjectName}`
///
pub fn object(bucket_name: Identifier, object_name: Identifier) -> ResourceName {
    object_in(Partition::default().into(), bucket_name, object_name)
}

///
/// `arn:aws:s3:::${BucketName}/${ObjectName}`
///
/// This function will panic if `bucket` is not an ResourceName for an S3 bucket.
///
pub fn object_from(bucket: &ResourceName, object_name: Identifier) -> ResourceName {
    if bucket.service != S3.into() {
        panic!(
            "You can't make an S3 object from a {} ResourceName.",
            bucket.service
        );
    }
    ResourceName {
        resource: ResourceIdentifier::from_path(&[bucket.resource.clone(), object_name.into()]),
        ..bucket.clone()
    }
}

///
/// `arn:${Partition}:s3:${Region}:${Account}:job/${JobId}`
///
pub fn job_in(
    partition: Identifier,
    region: Identifier,
    account: AccountIdentifier,
    job_id: Identifier,
) -> ResourceName {
    ArnBuilder::service_id(S3.into())
        .in_partition_id(partition)
        .in_region_id(region)
        .owned_by(account)
        .is(job_id.into())
        .into()
}

///
/// `arn:aws:s3:${Region}:${Account}:job/${JobId}`
///
pub fn job(region: Identifier, account: AccountIdentifier, job_id: Identifier) -> ResourceName {
    job_in(Partition::default().into(), region, account, job_id)
}