com.amazonaws.services.identitymanagement.model

Class CreatePolicyVersionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.CreatePolicyVersionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreatePolicyVersionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreatePolicyVersion operation.

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

See Also:

AmazonIdentityManagement.createPolicyVersion(CreatePolicyVersionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreatePolicyVersionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreatePolicyVersionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getPolicyArn() The Amazon Resource Name (ARN).
String	getPolicyDocument() The policy document.
Boolean	getSetAsDefault() Specifies whether to set this version as the policy's default version.
int	hashCode()
Boolean	isSetAsDefault() Specifies whether to set this version as the policy's default version.
void	setPolicyArn(String policyArn) The Amazon Resource Name (ARN).
void	setPolicyDocument(String policyDocument) The policy document.
void	setSetAsDefault(Boolean setAsDefault) Specifies whether to set this version as the policy's default version.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePolicyVersionRequest	withPolicyArn(String policyArn) The Amazon Resource Name (ARN).
CreatePolicyVersionRequest	withPolicyDocument(String policyDocument) The policy document.
CreatePolicyVersionRequest	withSetAsDefault(Boolean setAsDefault) Specifies whether to set this version as the policy's default version.

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

CreatePolicyVersionRequest

public CreatePolicyVersionRequest()

Method Detail

getPolicyArn

public String getPolicyArn()

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.

setPolicyArn

public void setPolicyArn(String policyArn)

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:

policyArn - 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.

withPolicyArn

public CreatePolicyVersionRequest withPolicyArn(String policyArn)

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:

policyArn - 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.

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 CreatePolicyVersionRequest 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.

isSetAsDefault

public Boolean isSetAsDefault()

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

Returns:

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

setSetAsDefault

public void setSetAsDefault(Boolean setAsDefault)

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

Parameters:

setAsDefault - Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

withSetAsDefault

public CreatePolicyVersionRequest withSetAsDefault(Boolean setAsDefault)

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

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

Parameters:

setAsDefault - Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

Returns:

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

getSetAsDefault

public Boolean getSetAsDefault()

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

Returns:

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the Using IAM guide.

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 CreatePolicyVersionRequest 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()