com.amazonaws.auth.policy

Class Principal

java.lang.Object

com.amazonaws.auth.policy.Principal

public class Principal
extends Object

A principal is an AWS account or AWS web serivce, which is being allowed or denied access to a resource through an access control policy. The principal is a property of the Statement object, not directly the Policy object.

The principal is A in the statement "A has permission to do B to C where D applies."

In an access control policy statement, you can set the principal to all authenticated AWS users through the AllUsers member. This is useful when you don't want to restrict access based on the identity of the requester, but instead on other identifying characteristics such as the requester's IP address.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Principal.Services The services who have the right to do the assume the role action.
static class	Principal.WebIdentityProviders Web identity providers, such as Login with Amazon, Facebook, or Google.

Field Summary

Fields

Modifier and Type	Field and Description
static Principal	AllUsers Principal instance that includes all users, including anonymous users.

Constructor Summary

Constructors

Constructor and Description
Principal(Principal.Services service) Constructs a new principal with the specified AWS web service which is being allowed or denied access to a resource through an access control policy.
Principal(Principal.WebIdentityProviders webIdentityProvider) Constructs a new principal with the specified web identity provider.
Principal(String accountId) Constructs a new principal with the specified AWS account ID.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Returns the unique ID for this principal.
String	getProvider() Returns the provider for this principal, which indicates in what group of users this principal resides.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AllUsers

public static final Principal AllUsers

Principal instance that includes all users, including anonymous users.

This is useful when you don't want to restrict access based on the identity of the requester, but instead on other identifying characteristics such as the requester's IP address.

Constructor Detail

Principal

public Principal(Principal.Services service)

Constructs a new principal with the specified AWS web service which is being allowed or denied access to a resource through an access control policy.

Parameters:

service - An AWS service.

Principal

public Principal(String accountId)

Constructs a new principal with the specified AWS account ID.

Parameters:

accountId - An AWS account ID.

Principal

public Principal(Principal.WebIdentityProviders webIdentityProvider)

Constructs a new principal with the specified web identity provider.

Parameters:

webIdentityProvider - An web identity provider.

Method Detail

getProvider

public String getProvider()

Returns the provider for this principal, which indicates in what group of users this principal resides.

Returns:

The provider for this principal.

getId

public String getId()

Returns the unique ID for this principal.

Returns:

The unique ID for this principal.