Struct aws_arn::ResourceName

pub struct ResourceName {
    pub partition: Option<Identifier>,
    pub service: Identifier,
    pub region: Option<Identifier>,
    pub account_id: Option<AccountIdentifier>,
    pub resource: ResourceIdentifier,
}

Amazon Resource Names (ResourceNames) uniquely identify AWS resources. We require an ResourceName when you need to specify a resource unambiguously across all of AWS, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.

The following are the general formats for ResourceNames; the specific components and values used depend on the AWS service.

arn:partition:service:region:account-id:resource-id
arn:partition:service:region:account-id:resource-type/resource-id
arn:partition:service:region:account-id:resource-type:resource-id

From ResourceName Format

Fields

partition: Option<Identifier>

The partition that the resource is in. For standard AWS Regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China partition is aws-cn. The module known::partition provides common values as constants (if the known feature is enabled).

service: Identifier

The service namespace that identifies the AWS. The module known::service provides

region: Option<Identifier>

The Region that the resource resides in. The ResourceNames for some resources do not require a Region, so this component might be omitted. The module known::region provides common values as constants (if the known feature is enabled).

account_id: Option<AccountIdentifier>

The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. The ResourceNames for some resources don’t require an account number, so this component may be omitted.

resource: ResourceIdentifier

The content of this part of the ResourceName varies by service. A resource identifier can be the name or ID of the resource (for example, user/Bob or instance/i-1234567890abcdef0) or a resource path. For example, some resource identifiers include a parent resource (sub-resource-type/parent-resource/sub-resource) or a qualifier such as a version (resource-type:resource-name:qualifier).

Implementations

impl ResourceName

pub fn new(service: Identifier, resource: ResourceIdentifier) -> Self

Construct a minimal ResourceName value with simply a service and resource.

pub fn aws(service: Identifier, resource: ResourceIdentifier) -> Self

Construct a minimal ResourceName value with simply a service and resource in the aws partition.

pub fn has_variables(&self) -> bool

Return true if the identifier contains variables of the form ${name}, else false.

pub fn replace_variables<V>(
    &self,
    context: &HashMap<String, V>
) -> Result<Self, Error> where
    V: Clone + Into<String>, 

Replace any variables in the string with values from the context, returning a new value if the replacements result in a legal identifier string. The

Trait Implementations

impl Clone for ResourceName

fn clone(&self) -> ResourceName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ResourceName

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

Formats the value using the given formatter.

impl From<&mut ArnBuilder> for ResourceName

fn from(v: &mut ArnBuilder) -> Self

Converts to this type from the input type.

impl From<AccountIdentifier> for ResourceName

fn from(account: AccountIdentifier) -> Self

Converts to this type from the input type.

impl From<ArnBuilder> for ResourceName

fn from(v: ArnBuilder) -> Self

Converts to this type from the input type.

impl FromStr for ResourceName

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

Format:

• arn:partition:service:region:account-id: | resource part |

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq<ResourceName> for ResourceName

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

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

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

This method tests for !=.

impl Serialize for ResourceName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResourceName