org.jclouds.iam.features

Interface InstanceProfileApi

public interface InstanceProfileApi

Author:

Adrian Cole

See Also:

InstanceProfileAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(String name, String roleName) Adds the specified role to the specified instance profile.
InstanceProfile	create(String name) Creates a new instance profile for your AWS account
InstanceProfile	createWithPath(String name, String path) like create(String), except you can specify a path.
void	delete(String name) Deletes the specified instanceProfile.
InstanceProfile	get(String name) Retrieves information about the specified instance profile, including the instance profile's path, GUID, and ARN.
PagedIterable<InstanceProfile>	list() returns all instance profiles in order.
IterableWithMarker<InstanceProfile>	listAt(String marker) retrieves up to 100 instance profiles in order, starting at marker
IterableWithMarker<InstanceProfile>	listFirstPage() retrieves up to 100 instance profiles in order.
PagedIterable<InstanceProfile>	listPathPrefix(String pathPrefix) returns all instance profiles in order at the specified pathPrefix.
IterableWithMarker<InstanceProfile>	listPathPrefixAt(String pathPrefix, String marker) retrieves up to 100 instance profiles in order at the specified pathPrefix, starting at marker.
IterableWithMarker<InstanceProfile>	listPathPrefixFirstPage(String pathPrefix) retrieves up to 100 instance profiles in order at the specified pathPrefix.
void	removeRole(String name, String roleName) Removes the specified role from the specified instance profile.

Method Detail

create

InstanceProfile create(String name)

Creates a new instance profile for your AWS account

Parameters:

name - Name of the instance profile to create.

Returns:

the new instance profile

createWithPath

InstanceProfile createWithPath(String name,
                             String path)

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

list

PagedIterable<InstanceProfile> list()

returns all instance profiles in order.

listFirstPage

IterableWithMarker<InstanceProfile> listFirstPage()

retrieves up to 100 instance profiles in order.

listAt

IterableWithMarker<InstanceProfile> listAt(String marker)

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

Parameters:

marker - starting point to resume the list

listPathPrefix

PagedIterable<InstanceProfile> listPathPrefix(String pathPrefix)

returns all instance profiles in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixFirstPage

IterableWithMarker<InstanceProfile> listPathPrefixFirstPage(String pathPrefix)

retrieves up to 100 instance profiles in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixAt

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

retrieves up to 100 instance profiles 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
InstanceProfile get(String name)

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

Parameters:

name - Name of the instance profile to get information about.

Returns:

null if not found

delete

void delete(String name)

Deletes the specified instanceProfile. The instance profile must not have any policies attached.

Parameters:

name - Name of the instance profile to delete

addRole

void addRole(String name,
           String roleName)

Adds the specified role to the specified instance profile.

Parameters:

name - Name of the instance profile to update.

roleName - Name of the role to add

removeRole

void removeRole(String name,
              String roleName)

Removes the specified role from the specified instance profile.

Parameters:

name - Name of the instance profile to update.

roleName - Name of the role to remove