com.amazonaws.services.identitymanagement.model

Class SimulatePrincipalPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SimulatePrincipalPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SimulatePrincipalPolicyRequest()

Method Summary

Modifier and Type	Method and Description
SimulatePrincipalPolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getActionNames() A list of names of API actions to evaluate in the simulation.
String	getCallerArn() The ARN of the IAM user that you want to specify as the simulated caller of the APIs.
List<ContextEntry>	getContextEntries() A list of context keys and corresponding values for the simulation to use.
String	getMarker() Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
Integer	getMaxItems() (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.
List<String>	getPolicyInputList() An optional list of additional policy documents to include in the simulation.
String	getPolicySourceArn() The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
List<String>	getResourceArns() A list of ARNs of AWS resources to include in the simulation.
String	getResourceHandlingOption() Specifies the type of simulation to run.
String	getResourceOwner() An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object.
String	getResourcePolicy() A resource-based policy to include in the simulation provided as a string.
int	hashCode()
void	setActionNames(Collection<String> actionNames) A list of names of API actions to evaluate in the simulation.
void	setCallerArn(String callerArn) The ARN of the IAM user that you want to specify as the simulated caller of the APIs.
void	setContextEntries(Collection<ContextEntry> contextEntries) A list of context keys and corresponding values for the simulation to use.
void	setMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
void	setMaxItems(Integer maxItems) (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.
void	setPolicyInputList(Collection<String> policyInputList) An optional list of additional policy documents to include in the simulation.
void	setPolicySourceArn(String policySourceArn) The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
void	setResourceArns(Collection<String> resourceArns) A list of ARNs of AWS resources to include in the simulation.
void	setResourceHandlingOption(String resourceHandlingOption) Specifies the type of simulation to run.
void	setResourceOwner(String resourceOwner) An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object.
void	setResourcePolicy(String resourcePolicy) A resource-based policy to include in the simulation provided as a string.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SimulatePrincipalPolicyRequest	withActionNames(Collection<String> actionNames) A list of names of API actions to evaluate in the simulation.
SimulatePrincipalPolicyRequest	withActionNames(String... actionNames) A list of names of API actions to evaluate in the simulation.
SimulatePrincipalPolicyRequest	withCallerArn(String callerArn) The ARN of the IAM user that you want to specify as the simulated caller of the APIs.
SimulatePrincipalPolicyRequest	withContextEntries(Collection<ContextEntry> contextEntries) A list of context keys and corresponding values for the simulation to use.
SimulatePrincipalPolicyRequest	withContextEntries(ContextEntry... contextEntries) A list of context keys and corresponding values for the simulation to use.
SimulatePrincipalPolicyRequest	withMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
SimulatePrincipalPolicyRequest	withMaxItems(Integer maxItems) (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.
SimulatePrincipalPolicyRequest	withPolicyInputList(Collection<String> policyInputList) An optional list of additional policy documents to include in the simulation.
SimulatePrincipalPolicyRequest	withPolicyInputList(String... policyInputList) An optional list of additional policy documents to include in the simulation.
SimulatePrincipalPolicyRequest	withPolicySourceArn(String policySourceArn) The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
SimulatePrincipalPolicyRequest	withResourceArns(Collection<String> resourceArns) A list of ARNs of AWS resources to include in the simulation.
SimulatePrincipalPolicyRequest	withResourceArns(String... resourceArns) A list of ARNs of AWS resources to include in the simulation.
SimulatePrincipalPolicyRequest	withResourceHandlingOption(String resourceHandlingOption) Specifies the type of simulation to run.
SimulatePrincipalPolicyRequest	withResourceOwner(String resourceOwner) An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object.
SimulatePrincipalPolicyRequest	withResourcePolicy(String resourcePolicy) A resource-based policy to include in the simulation provided as a string.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimulatePrincipalPolicyRequest

public SimulatePrincipalPolicyRequest()

Method Detail

setPolicySourceArn

public void setPolicySourceArn(String policySourceArn)

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

policySourceArn - The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

getPolicySourceArn

public String getPolicySourceArn()

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

withPolicySourceArn

public SimulatePrincipalPolicyRequest withPolicySourceArn(String policySourceArn)

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

policySourceArn - The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

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

getPolicyInputList

public List<String> getPolicyInputList()

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

setPolicyInputList

public void setPolicyInputList(Collection<String> policyInputList)

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

policyInputList - An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

withPolicyInputList

public SimulatePrincipalPolicyRequest withPolicyInputList(String... policyInputList)

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

NOTE: This method appends the values to the existing list (if any). Use setPolicyInputList(java.util.Collection) or withPolicyInputList(java.util.Collection) if you want to override the existing values.

Parameters:

policyInputList - An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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

withPolicyInputList

public SimulatePrincipalPolicyRequest withPolicyInputList(Collection<String> policyInputList)

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

policyInputList - An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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

getActionNames

public List<String> getActionNames()

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

Returns:

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

setActionNames

public void setActionNames(Collection<String> actionNames)

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

Parameters:

actionNames - A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

withActionNames

public SimulatePrincipalPolicyRequest withActionNames(String... actionNames)

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

NOTE: This method appends the values to the existing list (if any). Use setActionNames(java.util.Collection) or withActionNames(java.util.Collection) if you want to override the existing values.

Parameters:

actionNames - A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

Returns:

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

withActionNames

public SimulatePrincipalPolicyRequest withActionNames(Collection<String> actionNames)

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

Parameters:

actionNames - A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

Returns:

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

getResourceArns

public List<String> getResourceArns()

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

setResourceArns

public void setResourceArns(Collection<String> resourceArns)

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

resourceArns - A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

withResourceArns

public SimulatePrincipalPolicyRequest withResourceArns(String... resourceArns)

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

NOTE: This method appends the values to the existing list (if any). Use setResourceArns(java.util.Collection) or withResourceArns(java.util.Collection) if you want to override the existing values.

Parameters:

resourceArns - A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

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

withResourceArns

public SimulatePrincipalPolicyRequest withResourceArns(Collection<String> resourceArns)

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

resourceArns - A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

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

setResourcePolicy

public void setResourcePolicy(String resourcePolicy)

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

resourcePolicy - A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

getResourcePolicy

public String getResourcePolicy()

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

withResourcePolicy

public SimulatePrincipalPolicyRequest withResourcePolicy(String resourcePolicy)

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

resourcePolicy - A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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

setResourceOwner

public void setResourceOwner(String resourceOwner)

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

Parameters:

resourceOwner - An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

getResourceOwner

public String getResourceOwner()

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

Returns:

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

withResourceOwner

public SimulatePrincipalPolicyRequest withResourceOwner(String resourceOwner)

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

Parameters:

resourceOwner - An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

Returns:

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

setCallerArn

public void setCallerArn(String callerArn)

The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

callerArn - The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

getCallerArn

public String getCallerArn()

The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

withCallerArn

public SimulatePrincipalPolicyRequest withCallerArn(String callerArn)

The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Parameters:

callerArn - The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

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

getContextEntries

public List<ContextEntry> getContextEntries()

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Returns:

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

setContextEntries

public void setContextEntries(Collection<ContextEntry> contextEntries)

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Parameters:

contextEntries - A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

withContextEntries

public SimulatePrincipalPolicyRequest withContextEntries(ContextEntry... contextEntries)

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

NOTE: This method appends the values to the existing list (if any). Use setContextEntries(java.util.Collection) or withContextEntries(java.util.Collection) if you want to override the existing values.

Parameters:

contextEntries - A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Returns:

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

withContextEntries

public SimulatePrincipalPolicyRequest withContextEntries(Collection<ContextEntry> contextEntries)

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Parameters:

contextEntries - A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Returns:

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

setResourceHandlingOption

public void setResourceHandlingOption(String resourceHandlingOption)

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

Parameters:

resourceHandlingOption - Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

getResourceHandlingOption

public String getResourceHandlingOption()

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

Returns:

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

withResourceHandlingOption

public SimulatePrincipalPolicyRequest withResourceHandlingOption(String resourceHandlingOption)

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

Parameters:

resourceHandlingOption - Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

• EC2-Classic-InstanceStore

  instance, image, security-group

• EC2-Classic-EBS

  instance, image, security-group, volume

• EC2-VPC-InstanceStore

  instance, image, security-group, network-interface

• EC2-VPC-InstanceStore-Subnet

  instance, image, security-group, network-interface, subnet

• EC2-VPC-EBS

  instance, image, security-group, network-interface, volume

• EC2-VPC-EBS-Subnet

  instance, image, security-group, network-interface, subnet, volume

Returns:

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

setMaxItems

public void setMaxItems(Integer maxItems)

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Parameters:

maxItems - (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getMaxItems

public Integer getMaxItems()

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

withMaxItems

public SimulatePrincipalPolicyRequest withMaxItems(Integer maxItems)

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Parameters:

maxItems - (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

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

setMarker

public void setMarker(String marker)

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Parameters:

marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getMarker

public String getMarker()

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

withMarker

public SimulatePrincipalPolicyRequest withMarker(String marker)

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Parameters:

marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SimulatePrincipalPolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()