org.jclouds.sts

Interface STSApi

All Superinterfaces:

AutoCloseable, Closeable

public interface STSApi
extends Closeable

Provides access to Amazon STS via the Query API

Author:

Adrian Cole

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
UserAndSessionCredentials	assumeRole(String roleArn, String sessionName) Assumes a role for a specified session.
UserAndSessionCredentials	assumeRole(String roleArn, String sessionName, AssumeRoleOptions options) like assumeRole(String, String), except you can modify the timeout and other parameters.
UserAndSessionCredentials	createFederatedUser(String userName) Returns a set of temporary credentials for a federated user with the user name specified.
UserAndSessionCredentials	createFederatedUser(String userName, FederatedUserOptions options) like createFederatedUser(String), except you can modify the timeout and other parameters.
SessionCredentials	createTemporaryCredentials() Returns a set of temporary credentials for an AWS account or IAM user, with a default timeout
SessionCredentials	createTemporaryCredentials(SessionCredentialsOptions options) like createTemporaryCredentials(), except you can modify the timeout and other parameters.

Methods inherited from interface java.io.Closeable

close

Method Detail

createTemporaryCredentials

@Named(value="GetSessionToken")
SessionCredentials createTemporaryCredentials()

Returns a set of temporary credentials for an AWS account or IAM user, with a default timeout

createTemporaryCredentials

@Named(value="GetSessionToken")
SessionCredentials createTemporaryCredentials(SessionCredentialsOptions options)

like createTemporaryCredentials(), except you can modify the timeout and other parameters.

assumeRole

@Named(value="AssumeRole")
UserAndSessionCredentials assumeRole(String roleArn,
                                         String sessionName)

Assumes a role for a specified session. Only IAM users can assume a role.

Parameters:

sessionName - An identifier for the assumed role session, included as part of User.getId().

roleArn - The Amazon Resource Name (ARN) of the role that the caller is assuming.

assumeRole

@Named(value="AssumeRole")
UserAndSessionCredentials assumeRole(String roleArn,
                                         String sessionName,
                                         AssumeRoleOptions options)

like assumeRole(String, String), except you can modify the timeout and other parameters.

createFederatedUser

@Named(value="GetFederationToken")
UserAndSessionCredentials createFederatedUser(String userName)

Returns a set of temporary credentials for a federated user with the user name specified.

Parameters:

userName - The name of the federated user, included as part of User.getId().

createFederatedUser

@Named(value="GetFederationToken")
UserAndSessionCredentials createFederatedUser(String userName,
                                                  FederatedUserOptions options)

like createFederatedUser(String), except you can modify the timeout and other parameters.