Policy (AWS SDK For Java for OSGi 1.10.0 API)

java.lang.Object
- com.amazonaws.services.identitymanagement.model.Policy

All Implemented Interfaces:

Serializable, Cloneable
```
public class Policy
extends Object
implements Serializable, Cloneable
```
Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Policy()

Constructors
Constructor and Description
`Policy()`

Method Summary

Methods
Modifier and Type	Method and Description
`Policy`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN).
`Integer`	`getAttachmentCount()` The number of entities (users, groups, and roles) that the policy is attached to.
`Date`	`getCreateDate()` The date and time, in ISO 8601 date-time format, when the policy was created.
`String`	`getDefaultVersionId()` The identifier for the version of the policy that is set as the default version.
`String`	`getDescription()` A friendly description of the policy.
`Boolean`	`getIsAttachable()` Specifies whether the policy can be attached to an IAM user, group, or role.
`String`	`getPath()` The path to the policy.
`String`	`getPolicyId()` The stable and unique string identifying the policy.
`String`	`getPolicyName()` The friendly name (not ARN) identifying the policy.
`Date`	`getUpdateDate()` The date and time, in ISO 8601 date-time format, when the policy was last updated.
`int`	`hashCode()`
`Boolean`	`isAttachable()` Specifies whether the policy can be attached to an IAM user, group, or role.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN).
`void`	`setAttachmentCount(Integer attachmentCount)` The number of entities (users, groups, and roles) that the policy is attached to.
`void`	`setCreateDate(Date createDate)` The date and time, in ISO 8601 date-time format, when the policy was created.
`void`	`setDefaultVersionId(String defaultVersionId)` The identifier for the version of the policy that is set as the default version.
`void`	`setDescription(String description)` A friendly description of the policy.
`void`	`setIsAttachable(Boolean isAttachable)` Specifies whether the policy can be attached to an IAM user, group, or role.
`void`	`setPath(String path)` The path to the policy.
`void`	`setPolicyId(String policyId)` The stable and unique string identifying the policy.
`void`	`setPolicyName(String policyName)` The friendly name (not ARN) identifying the policy.
`void`	`setUpdateDate(Date updateDate)` The date and time, in ISO 8601 date-time format, when the policy was last updated.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Policy`	`withArn(String arn)` The Amazon Resource Name (ARN).
`Policy`	`withAttachmentCount(Integer attachmentCount)` The number of entities (users, groups, and roles) that the policy is attached to.
`Policy`	`withCreateDate(Date createDate)` The date and time, in ISO 8601 date-time format, when the policy was created.
`Policy`	`withDefaultVersionId(String defaultVersionId)` The identifier for the version of the policy that is set as the default version.
`Policy`	`withDescription(String description)` A friendly description of the policy.
`Policy`	`withIsAttachable(Boolean isAttachable)` Specifies whether the policy can be attached to an IAM user, group, or role.
`Policy`	`withPath(String path)` The path to the policy.
`Policy`	`withPolicyId(String policyId)` The stable and unique string identifying the policy.
`Policy`	`withPolicyName(String policyName)` The friendly name (not ARN) identifying the policy.
`Policy`	`withUpdateDate(Date updateDate)` The date and time, in ISO 8601 date-time format, when the policy was last updated.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Policy
```
public Policy()
```
- Method Detail
  - getPolicyName
```
public String getPolicyName()
```
    The friendly name (not ARN) identifying the policy.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]*
    
    Returns:
    The friendly name (not ARN) identifying the policy.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The friendly name (not ARN) identifying the policy.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]*
    
    Parameters:
    policyName - The friendly name (not ARN) identifying the policy.
  - withPolicyName
```
public Policy withPolicyName(String policyName)
```
    The friendly name (not ARN) identifying the policy.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]*
    
    Parameters:
    policyName - The friendly name (not ARN) identifying the policy.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPolicyId
```
public String getPolicyId()
```
    The stable and unique string identifying the policy.
    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 policy.
    For more information about IDs, see IAM Identifiers in the Using IAM guide.
  - setPolicyId
```
public void setPolicyId(String policyId)
```
    The stable and unique string identifying the policy.
    For more information about IDs, see IAM Identifiers in the Using IAM guide.
    Constraints:
    Length: 16 - 32
    Pattern: [\w]*
    
    Parameters:
    policyId - The stable and unique string identifying the policy.
    For more information about IDs, see IAM Identifiers in the Using IAM guide.
  - withPolicyId
```
public Policy withPolicyId(String policyId)
```
    The stable and unique string identifying the policy.
    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:
    policyId - The stable and unique string identifying the policy.
    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). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    Constraints:
    Length: 20 - 2048
    
    Returns:
    The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    arn - The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
  - withArn
```
public Policy withArn(String arn)
```
    The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    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). ARNs are unique identifiers for AWS resources.
    For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPath
```
public String getPath()
```
    The path to the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    Constraints:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Returns:
    The path to the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
  - setPath
```
public void setPath(String path)
```
    The path to the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    Constraints:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Parameters:
    path - The path to the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
  - withPath
```
public Policy withPath(String path)
```
    The path to the policy.
    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:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Parameters:
    path - The path to the policy.
    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.
  - getDefaultVersionId
```
public String getDefaultVersionId()
```
    The identifier for the version of the policy that is set as the default version.
    Constraints:
    Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
    
    Returns:
    The identifier for the version of the policy that is set as the default version.
  - setDefaultVersionId
```
public void setDefaultVersionId(String defaultVersionId)
```
    The identifier for the version of the policy that is set as the default version.
    Constraints:
    Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
    
    Parameters:
    defaultVersionId - The identifier for the version of the policy that is set as the default version.
  - withDefaultVersionId
```
public Policy withDefaultVersionId(String defaultVersionId)
```
    The identifier for the version of the policy that is set as the default version.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
    
    Parameters:
    defaultVersionId - The identifier for the version of the policy that is set as the default version.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAttachmentCount
```
public Integer getAttachmentCount()
```
    The number of entities (users, groups, and roles) that the policy is attached to.
    
    Returns:
    The number of entities (users, groups, and roles) that the policy is attached to.
  - setAttachmentCount
```
public void setAttachmentCount(Integer attachmentCount)
```
    The number of entities (users, groups, and roles) that the policy is attached to.
    
    Parameters:
    attachmentCount - The number of entities (users, groups, and roles) that the policy is attached to.
  - withAttachmentCount
```
public Policy withAttachmentCount(Integer attachmentCount)
```
    The number of entities (users, groups, and roles) that the policy is attached to.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    attachmentCount - The number of entities (users, groups, and roles) that the policy is attached to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isAttachable
```
public Boolean isAttachable()
```
    Specifies whether the policy can be attached to an IAM user, group, or role.
    
    Returns:
    Specifies whether the policy can be attached to an IAM user, group, or role.
  - setIsAttachable
```
public void setIsAttachable(Boolean isAttachable)
```
    Specifies whether the policy can be attached to an IAM user, group, or role.
    
    Parameters:
    isAttachable - Specifies whether the policy can be attached to an IAM user, group, or role.
  - withIsAttachable
```
public Policy withIsAttachable(Boolean isAttachable)
```
    Specifies whether the policy can be attached to an IAM user, group, or role.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    isAttachable - Specifies whether the policy can be attached to an IAM user, group, or role.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIsAttachable
```
public Boolean getIsAttachable()
```
    Specifies whether the policy can be attached to an IAM user, group, or role.
    
    Returns:
    Specifies whether the policy can be attached to an IAM user, group, or role.
  - getDescription
```
public String getDescription()
```
    A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
    Constraints:
    Length: 0 - 1000
    
    Returns:
    A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
  - setDescription
```
public void setDescription(String description)
```
    A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
    Constraints:
    Length: 0 - 1000
    
    Parameters:
    description - A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
  - withDescription
```
public Policy withDescription(String description)
```
    A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1000
    
    Parameters:
    description - A friendly description of the policy.
    This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
    
    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 policy was created.
    
    Returns:
    The date and time, in ISO 8601 date-time format, when the policy was created.
  - setCreateDate
```
public void setCreateDate(Date createDate)
```
    The date and time, in ISO 8601 date-time format, when the policy was created.
    
    Parameters:
    createDate - The date and time, in ISO 8601 date-time format, when the policy was created.
  - withCreateDate
```
public Policy withCreateDate(Date createDate)
```
    The date and time, in ISO 8601 date-time format, when the policy 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 policy was created.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getUpdateDate
```
public Date getUpdateDate()
```
    The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
    
    Returns:
    The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
  - setUpdateDate
```
public void setUpdateDate(Date updateDate)
```
    The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
    
    Parameters:
    updateDate - The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
  - withUpdateDate
```
public Policy withUpdateDate(Date updateDate)
```
    The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    updateDate - The date and time, in ISO 8601 date-time format, when the policy was last updated.
    When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version 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 Policy clone()
```
    Overrides:
    
    clone in class Object

Class Policy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Policy

Method Detail

getPolicyName

setPolicyName

withPolicyName

getPolicyId

setPolicyId

withPolicyId

getArn

setArn

withArn

getPath

setPath

withPath

getDefaultVersionId

setDefaultVersionId

withDefaultVersionId

getAttachmentCount

setAttachmentCount

withAttachmentCount

isAttachable

setIsAttachable

withIsAttachable

getIsAttachable

getDescription

setDescription

withDescription

getCreateDate

setCreateDate

withCreateDate

getUpdateDate

setUpdateDate

withUpdateDate

toString

hashCode

equals

clone