com.amazonaws.services.iot.model

Class CreatePolicyVersionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreatePolicyVersionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreatePolicyVersionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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

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 certificates to which the policy is attached).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreatePolicyVersionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getPolicyDocument() The JSON document that describes the policy.
java.lang.String	getPolicyName() The policy name.
java.lang.Boolean	getSetAsDefault() Specifies whether the policy version is set as the default.
int	hashCode()
java.lang.Boolean	isSetAsDefault() Specifies whether the policy version is set as the default.
void	setPolicyDocument(java.lang.String policyDocument) The JSON document that describes the policy.
void	setPolicyName(java.lang.String policyName) The policy name.
void	setSetAsDefault(java.lang.Boolean setAsDefault) Specifies whether the policy version is set as the default.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePolicyVersionRequest	withPolicyDocument(java.lang.String policyDocument) The JSON document that describes the policy.
CreatePolicyVersionRequest	withPolicyName(java.lang.String policyName) The policy name.
CreatePolicyVersionRequest	withSetAsDefault(java.lang.Boolean setAsDefault) Specifies whether the policy version is set as the default.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePolicyVersionRequest

public CreatePolicyVersionRequest()

Method Detail

getPolicyName

public java.lang.String getPolicyName()

The policy name.

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

Returns:

The policy name.

setPolicyName

public void setPolicyName(java.lang.String policyName)

The policy name.

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

Parameters:

policyName -

The policy name.

withPolicyName

public CreatePolicyVersionRequest withPolicyName(java.lang.String policyName)

The policy name.

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

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

Parameters:

policyName -

The policy name.

Returns:

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

getPolicyDocument

public java.lang.String getPolicyDocument()

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Returns:

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

setPolicyDocument

public void setPolicyDocument(java.lang.String policyDocument)

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Parameters:

policyDocument -

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

withPolicyDocument

public CreatePolicyVersionRequest withPolicyDocument(java.lang.String policyDocument)

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

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

Parameters:

policyDocument -

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Returns:

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

isSetAsDefault

public java.lang.Boolean isSetAsDefault()

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns:

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

getSetAsDefault

public java.lang.Boolean getSetAsDefault()

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns:

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

setSetAsDefault

public void setSetAsDefault(java.lang.Boolean setAsDefault)

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Parameters:

setAsDefault -

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

withSetAsDefault

public CreatePolicyVersionRequest withSetAsDefault(java.lang.Boolean setAsDefault)

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

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

Parameters:

setAsDefault -

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object