public class SimulateCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
SimulateCustomPolicy operation.
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables maintained by AWS and its services that
provide details about the context of an API query request. You can use
the Condition element of an IAM policy to evaluate
context keys. To get the list of context keys that the policies
require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems and
Marker parameters to paginate the results.
NOOP| Constructor and Description |
|---|
SimulateCustomPolicyRequest() |
| Modifier and Type | Method and Description |
|---|---|
SimulateCustomPolicyRequest |
clone() |
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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic List<String> getPolicyInputList()
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.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.public void setPolicyInputList(Collection<String> policyInputList)
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.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.public SimulateCustomPolicyRequest withPolicyInputList(String... policyInputList)
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.
Returns a reference to this object so that method calls can be chained together.
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.public SimulateCustomPolicyRequest withPolicyInputList(Collection<String> policyInputList)
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 reference to this object so that method calls can be chained together.
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.public List<String> getActionNames()
iam:CreateUser.iam:CreateUser.public void setActionNames(Collection<String> actionNames)
iam:CreateUser.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.public SimulateCustomPolicyRequest withActionNames(String... actionNames)
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.
Returns a reference to this object so that method calls can be chained together.
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.public SimulateCustomPolicyRequest withActionNames(Collection<String> actionNames)
iam:CreateUser.
Returns a reference to this object so that method calls can be chained together.
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.public List<String> getResourceArns()
*
(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.
*
(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.
public void setResourceArns(Collection<String> resourceArns)
*
(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.
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.
public SimulateCustomPolicyRequest withResourceArns(String... resourceArns)
*
(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.
Returns a reference to this object so that method calls can be chained together.
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.
public SimulateCustomPolicyRequest withResourceArns(Collection<String> resourceArns)
*
(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 reference to this object so that method calls can be chained together.
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.
public String getResourcePolicy()
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
public void setResourcePolicy(String resourcePolicy)
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
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.public SimulateCustomPolicyRequest withResourcePolicy(String resourcePolicy)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
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.public String getResourceOwner()
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.
Constraints:
Length: 1 - 2048
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.public void setResourceOwner(String resourceOwner)
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.
Constraints:
Length: 1 - 2048
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.public SimulateCustomPolicyRequest withResourceOwner(String resourceOwner)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
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.public String getCallerArn()
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.
Constraints:
Length: 1 - 2048
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.
public void setCallerArn(String callerArn)
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.
Constraints:
Length: 1 - 2048
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.
public SimulateCustomPolicyRequest withCallerArn(String callerArn)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
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.
public List<ContextEntry> getContextEntries()
Condition
element in one of the simulated IAM permission policies, the
corresponding value is supplied.Condition
element in one of the simulated IAM permission policies, the
corresponding value is supplied.public void setContextEntries(Collection<ContextEntry> contextEntries)
Condition
element in one of the simulated IAM permission policies, the
corresponding value is supplied.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.public SimulateCustomPolicyRequest withContextEntries(ContextEntry... contextEntries)
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.
Returns a reference to this object so that method calls can be chained together.
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.public SimulateCustomPolicyRequest withContextEntries(Collection<ContextEntry> contextEntries)
Condition
element in one of the simulated IAM permission policies, the
corresponding value is supplied.
Returns a reference to this object so that method calls can be chained together.
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.public String getResourceHandlingOption()
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
Constraints:
Length: 1 - 64
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
public void setResourceHandlingOption(String resourceHandlingOption)
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
Constraints:
Length: 1 - 64
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
public SimulateCustomPolicyRequest withResourceHandlingOption(String resourceHandlingOption)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
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
public Integer getMaxItems()
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.
Constraints:
Range: 1 - 1000
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.
public void setMaxItems(Integer maxItems)
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.
Constraints:
Range: 1 - 1000
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.
public SimulateCustomPolicyRequest withMaxItems(Integer maxItems)
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 a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
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.
public String getMarker()
Marker element in the response that
you received to indicate where the next call should start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
Marker element in the response that
you received to indicate where the next call should start.public void setMarker(String marker)
Marker element in the response that
you received to indicate where the next call should start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
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.public SimulateCustomPolicyRequest withMarker(String marker)
Marker element in the response that
you received to indicate where the next call should start.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
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.public String toString()
toString in class ObjectObject.toString()public SimulateCustomPolicyRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2015. All rights reserved.