Struct scratchstack_arn::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. For ARNs used to match resource statements, see ArnPattern.

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.
• 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.

If any of the arguments are invalid, an ArnError is returned.

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.

const 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

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

Parse an ARN from a string.

type Err = ArnError

The associated error which can be returned from parsing.

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,

Feeds a slice of this type into the given Hasher.

impl Ord for Arn

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Arn> for Arn

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Arn> for Arn

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 StructuralEq for Arn

impl StructuralPartialEq for Arn