goarnie

README

goarnie

A Golang package for parsing and creating Amazon Resource Names (ARNs).

Supported ARN types

The following ARN types are currently supported:

• IAM User
• RDS Database Instance

IAM User

IAM User ARNs are represented by the IAMUserARN struct.

You can create instances of IAMUserARN by calling:

• MakeIAMUserARN(partition string, account string, name string) (IAMUserARN, error)
• MakeIAMUserARNFromString(value string) IAMUserARN

IAMUserARN functions

• Header() (string, error) gets the header. This should always be "arn".
• SetHeader(string) error sets the header.
• Partition() (string, error) gets the partition. This will be "aws" or "aws-cn".
• SetPartition(string) error sets the partition.
• Service() (string, error) gets the partition. This will be "iam", "rds", "s3", etc.
• SetService(string) error sets the partition.
• Region() (string, error) gets the region. This will be "us-east-1", "eu-west-2", "ap-southeast-1", etc.
• SetRegion(string) error sets the region.
• Account() (string, error) gets the account ID.
• SetAccount(string) error sets the account ID.
• ResourceType() (string, error) gets the resource type. This should always be "user".
• SetResourceType(string) error sets the resource type.
• Name() (string, error) gets the user's name.
• SetName(string) error sets the user's name.
• IsValid() (bool, string, error) checks if the instance is valid.
• ToARN() (string, error) gets the instance as a string ARN. The struct is also a Stringer.

MakeIAMUserARN(partition string, account string, name string) (IAMUserARN, error)

package main

import (
    "fmt"
    "github.com/cariad/goarnie"
)

func main() {
    arn, _ := goarnie.MakeIAMUserARN("aws", "555000000000", "rebecca")

    name, _ := arn.Name()
    fmt.Println(name)
    // rebecca

    fmt.Println(arn)
    // arn:aws:iam::555000000000:user/rebecca
}

MakeIAMUserARNFromString(value string) IAMUserARN

package main

import (
    "fmt"
    "github.com/cariad/goarnie"
)

func main() {
    arn := goarnie.MakeIAMUserARNFromString("arn:aws:iam::555000000000:user/rebecca")

    name, _ := arn.Name()
    fmt.Println(name)
    // rebecca

    fmt.Println(arn)
    // arn:aws:iam::555000000000:user/rebecca
}

RDS Database Instance

RDS Database Instance ARNs are represented by the RDSDatabaseInstanceARN struct.

You can create instances of RDSDatabaseInstanceARN by calling:

• MakeRDSDatabaseInstanceARN(partition string, region string, account string, database string) (DatabaseInstanceARN, error)
• MakeRDSDatabaseInstanceARNFromString(value string) DatabaseInstanceARN

RDSDatabaseInstanceARN functions

• Header() (string, error) gets the header. This should always be "arn".
• SetHeader(string) error sets the header.
• Partition() (string, error) gets the partition. This will be "aws" or "aws-cn".
• SetPartition(string) error sets the partition.
• Service() (string, error) gets the partition. This will be "iam", "rds", "s3", etc.
• SetService(string) error sets the partition.
• Region() (string, error) gets the region. This will be "us-east-1", "eu-west-2", "ap-southeast-1", etc.
• SetRegion(string) error sets the region.
• Account() (string, error) gets the account ID.
• SetAccount(string) error sets the account ID.
• ResourceType() (string, error) gets the resource type. This should always be "user".
• SetResourceType(string) error sets the resource type.
• DatabaseIdentifier() (string, error) gets the database identifier.
• SetDatabaseIdentifier(string) error sets the database identifier.
• IsValid() (bool, string, error) checks if the instance is valid.
• ToARN() (string, error) gets the instance as a string ARN. The struct is also a Stringer.

MakeRDSDatabaseInstanceARN(partition string, region string, account string, database string) (DatabaseInstanceARN, error)

package main

import (
    "fmt"
    "github.com/cariad/goarnie"
)

func main() {
    arn, _ := goarnie.MakeRDSDatabaseInstanceARN("aws", "eu-west-2", "555000000000", "my-database")

    databaseIdentifier, _ := arn.DatabaseIdentifier()
    fmt.Println(databaseIdentifier)
    // my-database

    fmt.Println(arn)
    // arn:aws:rds:eu-west-2:555000000000:db:my-database
}

MakeRDSDatabaseInstanceARNFromString(value string) DatabaseInstanceARN

package main

import (
    "fmt"
    "github.com/cariad/goarnie"
)

func main() {
    arn := goarnie.MakeRDSDatabaseInstanceARNFromString("arn:aws:rds:eu-west-2:555000000000:db:my-database")

    databaseIdentifier, _ := arn.DatabaseIdentifier()
    fmt.Println(databaseIdentifier)
    // my-database

    fmt.Println(arn)
    // arn:aws:rds:eu-west-2:555000000000:db:my-database
}

Licence, credit & sponsorship

This project is published under the MIT Licence.

You don't owe me anything in return, but as an indie freelance coder there are two things I'd appreciate:

• Credit. If your app or documentation has a credits page, please consider mentioning the projects you use.
• Cash. If you want and are able to support future development, please consider becoming a patron or buying me a coffee. Thank you!

Documentation

Index

• type ARN
  • func MakeARN(partition string, service string, region string, account string) (ARN, error)
  • func MakeARNFromString(arn string) ARN
  • func (arn ARN) Account() (string, error)
  • func (arn ARN) Header() (string, error)
  • func (arn ARN) IsValid() (bool, string, error)
  • func (arn ARN) Partition() (string, error)
  • func (arn ARN) Region() (string, error)
  • func (arn ARN) Service() (string, error)
  • func (arn *ARN) SetAccount(account string) error
  • func (arn *ARN) SetHeader(header string) error
  • func (arn *ARN) SetPartition(partition string) error
  • func (arn *ARN) SetRegion(region string) error
  • func (arn *ARN) SetService(service string) error
  • func (arn ARN) ToARN() (string, error)
• type DatabaseInstanceARN
  • func MakeRDSDatabaseInstanceARN(partition string, region string, account string, database string) (DatabaseInstanceARN, error)
  • func MakeRDSDatabaseInstanceARNFromString(value string) DatabaseInstanceARN
  • func (arn DatabaseInstanceARN) DatabaseIdentifier() (string, error)
  • func (arn DatabaseInstanceARN) IsValid() (bool, string, error)
  • func (arn DatabaseInstanceARN) ResourceType() (string, error)
  • func (arn *DatabaseInstanceARN) SetDatabaseIdentifier(database string) error
  • func (arn *DatabaseInstanceARN) SetResourceType(resourceType string) error
  • func (arn DatabaseInstanceARN) String() string
  • func (arn DatabaseInstanceARN) ToARN() (string, error)
• type IAMUserARN
  • func MakeIAMUserARN(partition string, account string, name string) (IAMUserARN, error)
  • func MakeIAMUserARNFromString(value string) IAMUserARN
  • func (arn IAMUserARN) IsValid() (bool, string, error)
  • func (arn IAMUserARN) Name() (string, error)
  • func (arn IAMUserARN) ResourceType() (string, error)
  • func (arn *IAMUserARN) SetName(name string) error
  • func (arn *IAMUserARN) SetResourceType(resourceType string) error
  • func (arn IAMUserARN) String() string
  • func (arn IAMUserARN) ToARN() (string, error)

Types

type ARN

type ARN struct {
	// contains filtered or unexported fields
}

ARN describes an Amazon Resource Name.

func MakeARN

func MakeARN(partition string, service string, region string, account string) (ARN, error)

MakeARN makes a new ARN.

func MakeARNFromString

func MakeARNFromString(arn string) ARN

MakeARNFromString makes a new ARN from a string.

func (ARN) Account

func (arn ARN) Account() (string, error)

Account gets the account ID.

func (ARN) Header

func (arn ARN) Header() (string, error)

Header gets the header.

func (ARN) IsValid

func (arn ARN) IsValid() (bool, string, error)

IsValid checks if the field values are valid.

func (ARN) Partition

func (arn ARN) Partition() (string, error)

Partition gets the partition.

func (ARN) Region

func (arn ARN) Region() (string, error)

Region gets the region.

func (ARN) Service

func (arn ARN) Service() (string, error)

Service gets the service.

func (*ARN) SetAccount

func (arn *ARN) SetAccount(account string) error

SetAccount sets the partition.

func (*ARN) SetHeader

func (arn *ARN) SetHeader(header string) error

SetHeader sets the header.

func (*ARN) SetPartition

func (arn *ARN) SetPartition(partition string) error

SetPartition sets the partition.

func (*ARN) SetRegion

func (arn *ARN) SetRegion(region string) error

SetRegion sets the region.

func (*ARN) SetService

func (arn *ARN) SetService(service string) error

SetService sets the service.

func (ARN) ToARN

func (arn ARN) ToARN() (string, error)

ToARN converts the ARN to a string ARN.

type DatabaseInstanceARN

type DatabaseInstanceARN struct {
	ARN
	// contains filtered or unexported fields
}

DatabaseInstanceARN describes the ARN of an RDS database instance.

func MakeRDSDatabaseInstanceARN

func MakeRDSDatabaseInstanceARN(partition string, region string, account string, database string) (DatabaseInstanceARN, error)

MakeRDSDatabaseInstanceARN makes a new DatabaseInstanceARN.

func MakeRDSDatabaseInstanceARNFromString

func MakeRDSDatabaseInstanceARNFromString(value string) DatabaseInstanceARN

MakeRDSDatabaseInstanceARNFromString makes a new DatabaseInstanceARN from a string.

func (DatabaseInstanceARN) DatabaseIdentifier

func (arn DatabaseInstanceARN) DatabaseIdentifier() (string, error)

DatabaseIdentifier gets the database identifier.

func (DatabaseInstanceARN) IsValid

func (arn DatabaseInstanceARN) IsValid() (bool, string, error)

IsValid checks if the field values are valid.

func (DatabaseInstanceARN) ResourceType

func (arn DatabaseInstanceARN) ResourceType() (string, error)

ResourceType gets the resource type.

func (*DatabaseInstanceARN) SetDatabaseIdentifier

func (arn *DatabaseInstanceARN) SetDatabaseIdentifier(database string) error

SetDatabaseIdentifier sets the database identifier.

func (*DatabaseInstanceARN) SetResourceType

func (arn *DatabaseInstanceARN) SetResourceType(resourceType string) error

SetResourceType sets the resource type.

func (DatabaseInstanceARN) String

func (arn DatabaseInstanceARN) String() string

func (DatabaseInstanceARN) ToARN

func (arn DatabaseInstanceARN) ToARN() (string, error)

ToARN converts the ARN to a string ARN.

type IAMUserARN

type IAMUserARN struct {
	ARN
	// contains filtered or unexported fields
}

IAMUserARN describes the ARN of an IAM User.

func MakeIAMUserARN

func MakeIAMUserARN(partition string, account string, name string) (IAMUserARN, error)

MakeIAMUserARN makes a new IAMUserARN.

func MakeIAMUserARNFromString

func MakeIAMUserARNFromString(value string) IAMUserARN

MakeIAMUserARNFromString makes a new v from a string.

func (IAMUserARN) IsValid

func (arn IAMUserARN) IsValid() (bool, string, error)

IsValid checks if the field values are valid.

func (IAMUserARN) Name

func (arn IAMUserARN) Name() (string, error)

Name gets the name.

func (IAMUserARN) ResourceType

func (arn IAMUserARN) ResourceType() (string, error)

ResourceType gets the resource type.

func (*IAMUserARN) SetName

func (arn *IAMUserARN) SetName(name string) error

SetName sets the name.

func (*IAMUserARN) SetResourceType

func (arn *IAMUserARN) SetResourceType(resourceType string) error

SetResourceType sets the resource type.

func (IAMUserARN) String

func (arn IAMUserARN) String() string

func (IAMUserARN) ToARN

func (arn IAMUserARN) ToARN() (string, error)

ToARN converts the ARN to a string ARN.