public static interface SimulateCustomPolicyRequest.Builder extends IamRequest.Builder, CopyableBuilder<SimulateCustomPolicyRequest.Builder,SimulateCustomPolicyRequest>
| Modifier and Type | Method and Description |
|---|---|
SimulateCustomPolicyRequest.Builder |
actionNames(Collection<String> actionNames)
A list of names of API actions to evaluate in the simulation.
|
SimulateCustomPolicyRequest.Builder |
actionNames(String... actionNames)
A list of names of API actions to evaluate in the simulation.
|
SimulateCustomPolicyRequest.Builder |
callerArn(String callerArn)
The ARN of the IAM user that you want to use as the simulated caller of the APIs.
|
SimulateCustomPolicyRequest.Builder |
contextEntries(Collection<ContextEntry> contextEntries)
A list of context keys and corresponding values for the simulation to use.
|
SimulateCustomPolicyRequest.Builder |
contextEntries(Consumer<ContextEntry.Builder>... contextEntries)
A list of context keys and corresponding values for the simulation to use.
|
SimulateCustomPolicyRequest.Builder |
contextEntries(ContextEntry... contextEntries)
A list of context keys and corresponding values for the simulation to use.
|
SimulateCustomPolicyRequest.Builder |
marker(String marker)
Use this parameter only when paginating results and only after you receive a response indicating that the
results are truncated.
|
SimulateCustomPolicyRequest.Builder |
maxItems(Integer maxItems)
(Optional) Use this only when paginating results to indicate the maximum number of items you want in the
response.
|
SimulateCustomPolicyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
SimulateCustomPolicyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
SimulateCustomPolicyRequest.Builder |
policyInputList(Collection<String> policyInputList)
A list of policy documents to include in the simulation.
|
SimulateCustomPolicyRequest.Builder |
policyInputList(String... policyInputList)
A list of policy documents to include in the simulation.
|
SimulateCustomPolicyRequest.Builder |
resourceArns(Collection<String> resourceArns)
A list of ARNs of AWS resources to include in the simulation.
|
SimulateCustomPolicyRequest.Builder |
resourceArns(String... resourceArns)
A list of ARNs of AWS resources to include in the simulation.
|
SimulateCustomPolicyRequest.Builder |
resourceHandlingOption(String resourceHandlingOption)
Specifies the type of simulation to run.
|
SimulateCustomPolicyRequest.Builder |
resourceOwner(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.Builder |
resourcePolicy(String resourcePolicy)
A resource-based policy to include in the simulation provided as a string.
|
buildoverrideConfigurationcopyapplyMutation, buildSimulateCustomPolicyRequest.Builder policyInputList(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.
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 ( ).
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.
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 ( ).
SimulateCustomPolicyRequest.Builder policyInputList(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.
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 ( ).
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.
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 ( ).
SimulateCustomPolicyRequest.Builder actionNames(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.
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.SimulateCustomPolicyRequest.Builder actionNames(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.
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.SimulateCustomPolicyRequest.Builder resourceArns(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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
SimulateCustomPolicyRequest.Builder resourceArns(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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
SimulateCustomPolicyRequest.Builder resourcePolicy(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 ( ).
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 ( ).
SimulateCustomPolicyRequest.Builder resourceOwner(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.
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.SimulateCustomPolicyRequest.Builder callerArn(String callerArn)
The ARN of the IAM 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.
callerArn - The ARN of the IAM 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.
SimulateCustomPolicyRequest.Builder contextEntries(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.
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.SimulateCustomPolicyRequest.Builder contextEntries(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.
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.SimulateCustomPolicyRequest.Builder contextEntries(Consumer<ContextEntry.Builder>... 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.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #contextEntries(List) .contextEntries - a consumer that will call methods on List.Builder #contextEntries(List) SimulateCustomPolicyRequest.Builder resourceHandlingOption(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
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
SimulateCustomPolicyRequest.Builder maxItems(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.
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.
SimulateCustomPolicyRequest.Builder marker(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.
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.SimulateCustomPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.SimulateCustomPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.