Struct Arn

pub struct Arn { /* private fields */ }

An Amazon Resource Name (ARN) representing an exact resource.

This is used to represent a known resource, such as an S3 bucket, EC2 instance, assumed role instance, etc. This is not used to represent resource statements in the IAM Aspen policy language, which may contain wildcards.

Arn objects are immutable.

Implementations

impl Arn

pub fn new( partition: &str, service: &str, region: &str, account_id: &str, resource: &str, ) -> Result<Self, ArnError>

Create a new ARN from the specified components.

• partition - The partition the resource is in (required). This is usually aws, aws-cn, or aws-us-gov for actual AWS resources, but may be any string meeting the rules specified in validate_partition for non-AWS resources.
• service - The service the resource belongs to (required). This is a service name like ec2 or s3. Non-AWS resources must conform to the naming rules specified in validate_service.
• region - The region the resource is in (optional). If the resource is regional (and may other regions may have the resources with the same name), this is the region name. If the resource is global, this is empty. This is usually a region name like us-east-1 or us-west-2, but may be any string meeting the rules specified in validate_region.
• account_id - The account ID the resource belongs to (optional). This is the 12-digit account ID or the string aws for certain AWS-owned resources. Some resources (such as S3 buckets and objects) do not need the account ID (the bucket name is globally unique within a partition), so this may be empty.
• resource - The resource name (required). This is the name of the resource. The formatting is service-specific, but must be a valid UTF-8 string.

Errors

• If the partition is invalid, ArnError::InvalidPartition is returned.
• If the service is invalid, ArnError::InvalidService is returned.
• If the region is invalid, ArnError::InvalidRegion is returned.
• If the account ID is invalid, ArnError::InvalidAccountId is returned.

pub unsafe fn new_unchecked( partition: &str, service: &str, region: &str, account_id: &str, resource: &str, ) -> Self

Create a new ARN from the specified components, bypassing any validation.

Safety

The following constraints must be met:

• partition - Must meet the rules specified in validate_partition.
• service - Must meet the rules specified in validate_service.
• region - Must be empty or meet the rules specified in validate_region.
• account_id - Must be empty, a 12 ASCII digit account ID, or the string aws.
• resource - A valid UTF-8 string.

pub fn partition(&self) -> &str

Retrieve the partition the resource is in.

pub fn service(&self) -> &str

Retrieve the service the resource belongs to.

pub fn region(&self) -> &str

Retrieve the region the resource is in.

pub fn account_id(&self) -> &str

Retrieve the account ID the resource belongs to.

pub fn resource(&self) -> &str

Retrieve the resource name.

Trait Implementations

impl Clone for Arn

fn clone(&self) -> Arn

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Arn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Arn

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Arn

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Return the ARN.

impl FromStr for Arn

Parse a string into an Arn.

type Err = ArnError

ArnError is returned if the string is not a valid ARN.

fn from_str(s: &str) -> Result<Self, ArnError>

Parse an ARN from a string.

Errors

• If the ARN is not composed of 6 colon-separated components, ArnError::InvalidArn is returned.
• If the ARN does not start with arn:, ArnError::InvalidArn is returned.
• If the partition is invalid, ArnError::InvalidPartition is returned.
• If the service is invalid, ArnError::InvalidService is returned.
• If the region is invalid, ArnError::InvalidRegion is returned.
• If the account ID is invalid, ArnError::InvalidAccountId is returned.

impl Hash for Arn

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Arn

Orders ARNs by partition, service, region, account ID, and resource.

fn cmp(&self, other: &Self) -> Ordering

Returns the relative ordering between this and another ARN.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Arn

fn eq(&self, other: &Arn) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Arn

Orders ARNs by partition, service, region, account ID, and resource.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Returns the relative ordering between this and another ARN.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Arn

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Arn

impl StructuralPartialEq for Arn