CreatePolicyRequest (AWS SDK For Java for OSGi 1.10.10 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.identitymanagement.model.CreatePolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreatePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the CreatePolicy operation.
Creates a new managed policy for your AWS account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.

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

See Also:
AmazonIdentityManagement.createPolicy(CreatePolicyRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreatePolicyRequest()

Constructors
Constructor and Description
`CreatePolicyRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreatePolicyRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A friendly description of the policy.
`String`	`getPath()` The path for the policy.
`String`	`getPolicyDocument()` The policy document.
`String`	`getPolicyName()` The name of the policy document.
`int`	`hashCode()`
`void`	`setDescription(String description)` A friendly description of the policy.
`void`	`setPath(String path)` The path for the policy.
`void`	`setPolicyDocument(String policyDocument)` The policy document.
`void`	`setPolicyName(String policyName)` The name of the policy document.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreatePolicyRequest`	`withDescription(String description)` A friendly description of the policy.
`CreatePolicyRequest`	`withPath(String path)` The path for the policy.
`CreatePolicyRequest`	`withPolicyDocument(String policyDocument)` The policy document.
`CreatePolicyRequest`	`withPolicyName(String policyName)` The name of the policy document.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreatePolicyRequest
```
public CreatePolicyRequest()
```
- Method Detail
  - getPolicyName
```
public String getPolicyName()
```
    The name of the policy document.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]+
    
    Returns:
    The name of the policy document.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The name of the policy document.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]+
    
    Parameters:
    policyName - The name of the policy document.
  - withPolicyName
```
public CreatePolicyRequest withPolicyName(String policyName)
```
    The name of the policy document.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=,.@-]+
    
    Parameters:
    policyName - The name of the policy document.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPath
```
public String getPath()
```
    The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
    Constraints:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Returns:
    The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
  - setPath
```
public void setPath(String path)
```
    The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
    Constraints:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Parameters:
    path - The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
  - withPath
```
public CreatePolicyRequest withPath(String path)
```
    The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
    
    Parameters:
    path - The path for the policy.
    For more information about paths, see IAM Identifiers in the Using IAM guide.
    This parameter is optional. If it is not included, it defaults to a slash (/).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPolicyDocument
```
public String getPolicyDocument()
```
    The policy document.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Returns:
    The policy document.
  - setPolicyDocument
```
public void setPolicyDocument(String policyDocument)
```
    The policy document.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Parameters:
    policyDocument - The policy document.
  - withPolicyDocument
```
public CreatePolicyRequest withPolicyDocument(String policyDocument)
```
    The policy document.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Parameters:
    policyDocument - The policy document.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A friendly description of the policy.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
    Constraints:
    Length: 0 - 1000
    
    Returns:
    A friendly description of the policy.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
  - setDescription
```
public void setDescription(String description)
```
    A friendly description of the policy.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
    Constraints:
    Length: 0 - 1000
    
    Parameters:
    description - A friendly description of the policy.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
  - withDescription
```
public CreatePolicyRequest withDescription(String description)
```
    A friendly description of the policy.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
    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.
    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
    The policy description is immutable. After a value is assigned, it cannot be changed.
    
    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 CreatePolicyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Class CreatePolicyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreatePolicyRequest

Method Detail

getPolicyName

setPolicyName

withPolicyName

getPath

setPath

withPath

getPolicyDocument

setPolicyDocument

withPolicyDocument

getDescription

setDescription

withDescription

toString

hashCode

equals

clone