org.jclouds.iam.features

Interface RoleApi

public interface RoleApi

Author:

Adrian Cole

See Also:

RoleAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
Role	createWithPolicy(String name, String assumeRolePolicy) Creates a new role for your AWS account
Role	createWithPolicyAndPath(String name, String assumeRolePolicy, String path) like createWithPolicy(String, String), except you can specify a path.
void	delete(String name) Deletes the specified role.
Role	get(String name) Retrieves information about the specified role, including the role's path, GUID, and ARN.
PagedIterable<Role>	list() returns all roles in order.
IterableWithMarker<Role>	listAt(String marker) retrieves up to 100 roles in order, starting at marker
IterableWithMarker<Role>	listFirstPage() retrieves up to 100 roles in order.
IterableWithMarker<InstanceProfile>	listFirstPageOfInstanceProfiles(String name) retrieves up to 100 instance profiles in order for this role.
PagedIterable<InstanceProfile>	listInstanceProfiles(String name) returns all instance profiles in order for this role.
IterableWithMarker<InstanceProfile>	listInstanceProfilesAt(String name, String marker) retrieves up to 100 instance profiles in order for this role, starting at marker
PagedIterable<Role>	listPathPrefix(String pathPrefix) returns all roles in order at the specified pathPrefix.
IterableWithMarker<Role>	listPathPrefixAt(String pathPrefix, String marker) retrieves up to 100 roles in order at the specified pathPrefix, starting at marker.
IterableWithMarker<Role>	listPathPrefixFirstPage(String pathPrefix) retrieves up to 100 roles in order at the specified pathPrefix.

Method Detail

createWithPolicy

Role createWithPolicy(String name,
                    String assumeRolePolicy)

Creates a new role for your AWS account

Parameters:

name - Name of the role to create.

assumeRolePolicy - The policy that grants an entity permission to assume the role.}

Returns:

the new role

createWithPolicyAndPath

Role createWithPolicyAndPath(String name,
                           String assumeRolePolicy,
                           String path)

like createWithPolicy(String, String), except you can specify a path.

list

PagedIterable<Role> list()

returns all roles in order.

listFirstPage

IterableWithMarker<Role> listFirstPage()

retrieves up to 100 roles in order.

listAt

IterableWithMarker<Role> listAt(String marker)

retrieves up to 100 roles in order, starting at marker

Parameters:

marker - starting point to resume the list

listPathPrefix

PagedIterable<Role> listPathPrefix(String pathPrefix)

returns all roles in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixFirstPage

IterableWithMarker<Role> listPathPrefixFirstPage(String pathPrefix)

retrieves up to 100 roles in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixAt

IterableWithMarker<Role> listPathPrefixAt(String pathPrefix,
                                        String marker)

retrieves up to 100 roles in order at the specified pathPrefix, starting at marker.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

marker - starting point to resume the list

get

@Nullable
Role get(String name)

Retrieves information about the specified role, including the role's path, GUID, and ARN.

Parameters:

name - Name of the role to get information about.

Returns:

null if not found

listInstanceProfiles

PagedIterable<InstanceProfile> listInstanceProfiles(String name)

returns all instance profiles in order for this role.

Parameters:

name - Name of the role to get instance profiles for.

listFirstPageOfInstanceProfiles

IterableWithMarker<InstanceProfile> listFirstPageOfInstanceProfiles(String name)

retrieves up to 100 instance profiles in order for this role.

Parameters:

name - Name of the role to get instance profiles for.

listInstanceProfilesAt

IterableWithMarker<InstanceProfile> listInstanceProfilesAt(String name,
                                                         String marker)

retrieves up to 100 instance profiles in order for this role, starting at marker

Parameters:

name - Name of the role to get instance profiles for.

marker - starting point to resume the list

delete

void delete(String name)

Deletes the specified role. The role must not have any policies attached.

Parameters:

name - Name of the role to delete