AWS SDK for C++  1.9.159
AWS SDK for C++
Public Member Functions | List of all members
Aws::Utils::ARN Class Reference

#include <ARN.h>

+ Inheritance diagram for Aws::Utils::ARN:

Public Member Functions

 ARN (const Aws::String &arnString)
 
 operator bool () const
 
const Aws::StringGetARNString () const
 
const Aws::StringGetPartition () const
 
const Aws::StringGetService () const
 
const Aws::StringGetRegion () const
 
const Aws::StringGetAccountId () const
 
const Aws::StringGetResource () const
 

Detailed Description

ARN (Amazon Resource Name) is used to identify an unique resource on AWS. A full qualified ARN has two forms:

  1. arn:partition:service:region:account-id:resource-type:resource-id:qualifier
  2. arn:partition:service:region:account-id:resource-type/resource-id/qualifier Different services have different resource definition, here we treat anything after "[account-id]:" as resource. Service should have their own resource parser.

Definition at line 23 of file ARN.h.

Constructor & Destructor Documentation

◆ ARN()

Aws::Utils::ARN::ARN ( const Aws::String arnString)

Member Function Documentation

◆ GetAccountId()

const Aws::String& Aws::Utils::ARN::GetAccountId ( ) const
inline

Definition at line 43 of file ARN.h.

◆ GetARNString()

const Aws::String& Aws::Utils::ARN::GetARNString ( ) const
inline

Get the originating arn string.

Definition at line 35 of file ARN.h.

◆ GetPartition()

const Aws::String& Aws::Utils::ARN::GetPartition ( ) const
inline

Definition at line 37 of file ARN.h.

◆ GetRegion()

const Aws::String& Aws::Utils::ARN::GetRegion ( ) const
inline

Definition at line 41 of file ARN.h.

◆ GetResource()

const Aws::String& Aws::Utils::ARN::GetResource ( ) const
inline

Definition at line 45 of file ARN.h.

◆ GetService()

const Aws::String& Aws::Utils::ARN::GetService ( ) const
inline

Definition at line 39 of file ARN.h.

◆ operator bool()

Aws::Utils::ARN::operator bool ( ) const
inlineexplicit

return if the ARN is valid after construction.

Definition at line 30 of file ARN.h.


The documentation for this class was generated from the following file: