@InterfaceAudience.LimitedPrivate(value="Authentication services") @InterfaceStability.Unstable

Package org.apache.hadoop.fs.s3a.auth

Authentication and permissions support.

See: Description

Interface Summary

Interface	Description
AwsSignerInitializer	Interface which can be implemented to allow initialization of any custom signers which may be used by the S3AFileSystem.

Class Summary

Class	Description
AbstractAWSCredentialProvider	Base class for AWS credential providers which take a URI and config in their constructor.
AbstractSessionCredentialsProvider	Base class for session credential support.
AbstractSessionCredentialsProvider.NoCredentials	A special set of null credentials which are not the anonymous class.
AssumedRoleCredentialProvider	Support IAM Assumed roles by instantiating an instance of STSAssumeRoleSessionCredentialsProvider from configuration properties, including wiring up the inner authenticator, and, unless overridden, creating a session name from the current user.
CredentialProviderListFactory	This class provides methods to create a AWSCredentialProviderList list of AWS credential providers.
CustomHttpSigner	Custom signer that delegates to the AWS V4 signer.
CustomSdkSigner	This class is for testing the SDK's signing: it can be declared as the signer class in the configuration and then the full test suite run with it.
CustomSdkSigner.Initializer
IAMInstanceCredentialsProvider	This is an IAM credential provider which wraps an ContainerCredentialsProvider to provide credentials when the S3A connector is instantiated on AWS EC2 or the AWS container services.
MarshalledCredentialBinding	Class to bridge from the serializable/marshallabled MarshalledCredentialBinding class to/from AWS classes.
MarshalledCredentialProvider	AWS credential provider driven from marshalled session/full credentials (full, simple session or role).
MarshalledCredentials	Stores the credentials for a session or for a full login.
RoleModel	Jackson Role Model for Role Properties, for API clients and tests.
RoleModel.Policy	A policy is one or more statements.
RoleModel.RoleElt	Any element in a role.
RoleModel.Statement	A single statement.
RolePolicies	Operations, statements and policies covering the operations needed to work with S3.
SignerFactory	Signer factory used to register and create signers.
SignerManager	Class to handle custom signers.
STSClientFactory	Factory for creating STS Clients.
STSClientFactory.STSClient	STS client connection with retries.

Enum Summary

Enum	Description
MarshalledCredentials.CredentialTypeRequired	Enumeration of credential types for use in validation methods.
RoleModel.Effects	Effect options.

Exception Summary

Exception	Description
NoAuthWithAWSException	A specific subclass of SdkException which is used in the S3A retry policy to fail fast when there is any authentication problem.
NoAwsCredentialsException	A special exception which declares that no credentials were found; this can be treated specially in logging, handling, etc.

Package org.apache.hadoop.fs.s3a.auth Description

Authentication and permissions support. Some of the classes in here are expected to be referred to in configuration files, so must not change their name. These will be explicitly identified.