com.amazonaws.services.identitymanagement.model

Class Group

java.lang.Object

com.amazonaws.services.identitymanagement.model.Group

All Implemented Interfaces:

Serializable, Cloneable

public class Group
extends Object
implements Serializable, Cloneable

Contains information about an IAM group entity.

This data type is used as a response element in the following actions:

• CreateGroup
• GetGroup
• ListGroups

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Group() Default constructor for a new Group object.
Group(String path, String groupName, String groupId, String arn, Date createDate) Constructs a new Group object.

Method Summary

Methods

Modifier and Type	Method and Description
Group	clone()
boolean	equals(Object obj)
String	getArn() The Amazon Resource Name (ARN) specifying the group.
Date	getCreateDate() The date and time, in ISO 8601 date-time format, when the group was created.
String	getGroupId() The stable and unique string identifying the group.
String	getGroupName() The friendly name that identifies the group.
String	getPath() The path to the group.
int	hashCode()
void	setArn(String arn) The Amazon Resource Name (ARN) specifying the group.
void	setCreateDate(Date createDate) The date and time, in ISO 8601 date-time format, when the group was created.
void	setGroupId(String groupId) The stable and unique string identifying the group.
void	setGroupName(String groupName) The friendly name that identifies the group.
void	setPath(String path) The path to the group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Group	withArn(String arn) The Amazon Resource Name (ARN) specifying the group.
Group	withCreateDate(Date createDate) The date and time, in ISO 8601 date-time format, when the group was created.
Group	withGroupId(String groupId) The stable and unique string identifying the group.
Group	withGroupName(String groupName) The friendly name that identifies the group.
Group	withPath(String path) The path to the group.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group()

Default constructor for a new Group object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Group

public Group(String path,
     String groupName,
     String groupId,
     String arn,
     Date createDate)

Constructs a new Group object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

path - The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

groupName - The friendly name that identifies the group.

groupId - The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

arn - The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

createDate - The date and time, in ISO 8601 date-time format, when the group was created.

Method Detail

getPath

public String getPath()

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Returns:

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

setPath

public void setPath(String path)

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

withPath

public Group withPath(String path)

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getGroupName

public String getGroupName()

The friendly name that identifies the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Returns:

The friendly name that identifies the group.

setGroupName

public void setGroupName(String groupName)

The friendly name that identifies the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - The friendly name that identifies the group.

withGroupName

public Group withGroupName(String groupName)

The friendly name that identifies the group.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - The friendly name that identifies the group.

Returns:

A reference to this updated object so that method calls can be chained together.

getGroupId

public String getGroupId()

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Returns:

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

setGroupId

public void setGroupId(String groupId)

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

groupId - The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

withGroupId

public Group withGroupId(String groupId)

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

groupId - The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getArn

public String getArn()

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 20 - 2048

Returns:

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

setArn

public void setArn(String arn)

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

Constraints:
Length: 20 - 2048

Parameters:

arn - The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

withArn

public Group withArn(String arn)

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

arn - The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreateDate

public Date getCreateDate()

The date and time, in ISO 8601 date-time format, when the group was created.

Returns:

The date and time, in ISO 8601 date-time format, when the group was created.

setCreateDate

public void setCreateDate(Date createDate)

The date and time, in ISO 8601 date-time format, when the group was created.

Parameters:

createDate - The date and time, in ISO 8601 date-time format, when the group was created.

withCreateDate

public Group withCreateDate(Date createDate)

The date and time, in ISO 8601 date-time format, when the group was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

createDate - The date and time, in ISO 8601 date-time format, when the group was created.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Group clone()

Overrides:

clone in class Object