io.awspring.cloud.core.naming

Class AmazonResourceName

java.lang.Object

io.awspring.cloud.core.naming.AmazonResourceName

public final class AmazonResourceName
extends Object

Support class which is used to parse Amazon Webservice Resource Names. Resource names are unique identifiers for different type of resource inside the Amazon Webservices. These resource are represented by a service and could be bound into a particular region, if the service is region based. Also most of the resources will be typically bound to an account if the resource is scoped ot an account.

More information on resources are available on the Amazon Webservice Manual

Since:

1.0

Author:

Agim Emruli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmazonResourceName.Builder Builder for Amazon resources.

Method Summary

Modifier and Type	Method and Description
static AmazonResourceName	fromString(String name)
String	getAccount() Returns the account to which the resource is assigned.
String	getPartition() Returns the partition name of the service (currently aws, aws-cn, aws-us-gov).
String	getRegion() Returns the region to which the particular service for this object is bound.
String	getResourceName() Return the name of the resource inside the particular type.
String	getResourceType() Return the resource type for the resource.
String	getService() Returns the service name for this particular AmazonResourceName.
static boolean	isValidAmazonResourceName(String name)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

fromString

public static AmazonResourceName fromString(String name)

isValidAmazonResourceName

public static boolean isValidAmazonResourceName(String name)

getPartition

public String getPartition()

Returns the partition name of the service (currently aws, aws-cn, aws-us-gov).

Returns:

- the partition name - must start with aws

getService

public String getService()

Returns the service name for this particular AmazonResourceName. The service name is a plain string which will be one of the service from the namespace defined at user manual

Returns:

- the service as a string - never be null

getRegion

public String getRegion()

Returns the region to which the particular service for this object is bound. This is one of the known regions or null if the service is globally available (e.g. Amazon S3)

Returns:

- the region or null if the service is globally available

getAccount

public String getAccount()

Returns the account to which the resource is assigned. This is the account id to which the owner of the resources belongs to. If the resources does not have any owner (e.g. solutions stacks in ElasticBeansTalk) this method will return null

Returns:

- the account number of the resource owner or null for non assigned resources

getResourceType

public String getResourceType()

Return the resource type for the resource. This is service dependent and can be an user (for IAM) or a bucket (for S3). The resource type is never null and can be the resource name for particular service (e.g. Amazon SQS Queue or Amazon SNS Topic)

Returns:

the type of the resource of the name of the resource itself

getResourceName

public String getResourceName()

Return the name of the resource inside the particular type. This can be a bucket name for Amazon S3 or the subscriptions id for the subscription of one particular topic.

Returns:

- the resource name or null if the resource type itself is the name of the resource

toString

public String toString()

Overrides:

toString in class Object