SimulateCustomPolicyRequest (AWS SDK for Java

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

All Implemented Interfaces:: ReadLimitInfo, Serializable, Cloneable

public class SimulateCustomPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

SimulateCustomPolicyRequest()

Constructors
Constructor and Description
`SimulateCustomPolicyRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`SimulateCustomPolicyRequest`	`clone()` Creates a shallow clone of this request.
`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 user that you want to use 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()` Use this only when paginating results to indicate the maximum number of items you want in the response.
`List<String>`	`getPolicyInputList()` A list of policy documents 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 user that you want to use 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)` Use this only when paginating results to indicate the maximum number of items you want in the response.
`void`	`setPolicyInputList(Collection<String> policyInputList)` A list of policy documents 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.
`SimulateCustomPolicyRequest`	`withActionNames(Collection<String> actionNames)` A list of names of API actions to evaluate in the simulation.
`SimulateCustomPolicyRequest`	`withActionNames(String... actionNames)` A list of names of API actions to evaluate in the simulation.
`SimulateCustomPolicyRequest`	`withCallerArn(String callerArn)` The ARN of the user that you want to use as the simulated caller of the APIs.
`SimulateCustomPolicyRequest`	`withContextEntries(Collection<ContextEntry> contextEntries)` A list of context keys and corresponding values for the simulation to use.
`SimulateCustomPolicyRequest`	`withContextEntries(ContextEntry... contextEntries)` A list of context keys and corresponding values for the simulation to use.
`SimulateCustomPolicyRequest`	`withMarker(String marker)` Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
`SimulateCustomPolicyRequest`	`withMaxItems(Integer maxItems)` Use this only when paginating results to indicate the maximum number of items you want in the response.
`SimulateCustomPolicyRequest`	`withPolicyInputList(Collection<String> policyInputList)` A list of policy documents to include in the simulation.
`SimulateCustomPolicyRequest`	`withPolicyInputList(String... policyInputList)` A list of policy documents to include in the simulation.
`SimulateCustomPolicyRequest`	`withResourceArns(Collection<String> resourceArns)` A list of ARNs of AWS resources to include in the simulation.
`SimulateCustomPolicyRequest`	`withResourceArns(String... resourceArns)` A list of ARNs of AWS resources to include in the simulation.
`SimulateCustomPolicyRequest`	`withResourceHandlingOption(String resourceHandlingOption)` Specifies the type of simulation to run.
`SimulateCustomPolicyRequest`	`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.
`SimulateCustomPolicyRequest`	`withResourcePolicy(String resourcePolicy)` A resource-based policy to include in the simulation provided as a string.

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

- Constructor Detail
  - SimulateCustomPolicyRequest
```
public SimulateCustomPolicyRequest()
```
- Method Detail
  - getPolicyInputList
```
public List<String> getPolicyInputList()
```
    A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    Returns:
    A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
  - setPolicyInputList
```
public void setPolicyInputList(Collection<String> policyInputList)
```
    A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    Parameters:
    policyInputList - A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
  - withPolicyInputList
```
public SimulateCustomPolicyRequest withPolicyInputList(String... policyInputList)
```
    A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    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 - A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - withPolicyInputList
```
public SimulateCustomPolicyRequest withPolicyInputList(Collection<String> policyInputList)
```
    A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    Parameters:
    policyInputList - A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
    
    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 against 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 against 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 against 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 against each resource. Each action must include the service identifier, such as iam:CreateUser.
  - withActionNames
```
public SimulateCustomPolicyRequest withActionNames(String... actionNames)
```
    A list of names of API actions to evaluate in the simulation. Each action is evaluated against 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 against 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 SimulateCustomPolicyRequest withActionNames(Collection<String> actionNames)
```
    A list of names of API actions to evaluate in the simulation. Each action is evaluated against 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 against 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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
  - 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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
  - withResourceArns
```
public SimulateCustomPolicyRequest 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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - withResourceArns
```
public SimulateCustomPolicyRequest 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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    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.
    
    If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
    
    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.
    
    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.
  - 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.
    
    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.
  - withResourcePolicy
```
public SimulateCustomPolicyRequest 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.
    
    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.
    
    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 SimulateCustomPolicyRequest 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 user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
    
    Parameters:
    callerArn - The ARN of the user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
  - getCallerArn
```
public String getCallerArn()
```
    The ARN of the user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
    
    Returns:
    The ARN of the user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
  - withCallerArn
```
public SimulateCustomPolicyRequest withCallerArn(String callerArn)
```
    The ARN of the user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
    
    Parameters:
    callerArn - The ARN of the user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
    
    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.
    
    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 by a Condition element 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 by a Condition element 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 by a Condition element 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 by a Condition element in one of the simulated IAM permission policies, the corresponding value is supplied.
  - withContextEntries
```
public SimulateCustomPolicyRequest withContextEntries(ContextEntry... contextEntries)
```
    A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated by a Condition element 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 by a Condition element 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 SimulateCustomPolicyRequest withContextEntries(Collection<ContextEntry> contextEntries)
```
    A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated by a Condition element 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 by a Condition element 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 SimulateCustomPolicyRequest 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)
```
    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.
    
    This parameter is optional. If you do not include it, 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 - 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.
    
    This parameter is optional. If you do not include it, 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()
```
    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.
    
    This parameter is optional. If you do not include it, 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:
    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 .
    
    This parameter is optional. If you do not include it, 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 SimulateCustomPolicyRequest withMaxItems(Integer maxItems)
```
    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.
    
    This parameter is optional. If you do not include it, 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 - 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.
    
    This parameter is optional. If you do not include it, 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 SimulateCustomPolicyRequest 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 SimulateCustomPolicyRequest 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()

Did this page help you?

Class SimulateCustomPolicyRequest

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

SimulateCustomPolicyRequest

Method Detail

getPolicyInputList

setPolicyInputList

withPolicyInputList

withPolicyInputList

getActionNames

setActionNames

withActionNames

withActionNames

getResourceArns

setResourceArns

withResourceArns

withResourceArns

setResourcePolicy

getResourcePolicy

withResourcePolicy

setResourceOwner

getResourceOwner

withResourceOwner

setCallerArn

getCallerArn

withCallerArn

getContextEntries

setContextEntries

withContextEntries

withContextEntries

setResourceHandlingOption

getResourceHandlingOption

withResourceHandlingOption

setMaxItems

getMaxItems

withMaxItems

setMarker

getMarker

withMarker

toString

equals

hashCode

clone