AWS SDK for C++  1.8.28
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::IAM::Model::SimulateCustomPolicyRequest Class Reference

#include <SimulateCustomPolicyRequest.h>

+ Inheritance diagram for Aws::IAM::Model::SimulateCustomPolicyRequest:

Public Member Functions

 SimulateCustomPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetPolicyInputList () const
 
bool PolicyInputListHasBeenSet () const
 
void SetPolicyInputList (const Aws::Vector< Aws::String > &value)
 
void SetPolicyInputList (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestWithPolicyInputList (const Aws::Vector< Aws::String > &value)
 
SimulateCustomPolicyRequestWithPolicyInputList (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestAddPolicyInputList (const Aws::String &value)
 
SimulateCustomPolicyRequestAddPolicyInputList (Aws::String &&value)
 
SimulateCustomPolicyRequestAddPolicyInputList (const char *value)
 
const Aws::Vector< Aws::String > & GetPermissionsBoundaryPolicyInputList () const
 
bool PermissionsBoundaryPolicyInputListHasBeenSet () const
 
void SetPermissionsBoundaryPolicyInputList (const Aws::Vector< Aws::String > &value)
 
void SetPermissionsBoundaryPolicyInputList (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestWithPermissionsBoundaryPolicyInputList (const Aws::Vector< Aws::String > &value)
 
SimulateCustomPolicyRequestWithPermissionsBoundaryPolicyInputList (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestAddPermissionsBoundaryPolicyInputList (const Aws::String &value)
 
SimulateCustomPolicyRequestAddPermissionsBoundaryPolicyInputList (Aws::String &&value)
 
SimulateCustomPolicyRequestAddPermissionsBoundaryPolicyInputList (const char *value)
 
const Aws::Vector< Aws::String > & GetActionNames () const
 
bool ActionNamesHasBeenSet () const
 
void SetActionNames (const Aws::Vector< Aws::String > &value)
 
void SetActionNames (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestWithActionNames (const Aws::Vector< Aws::String > &value)
 
SimulateCustomPolicyRequestWithActionNames (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestAddActionNames (const Aws::String &value)
 
SimulateCustomPolicyRequestAddActionNames (Aws::String &&value)
 
SimulateCustomPolicyRequestAddActionNames (const char *value)
 
const Aws::Vector< Aws::String > & GetResourceArns () const
 
bool ResourceArnsHasBeenSet () const
 
void SetResourceArns (const Aws::Vector< Aws::String > &value)
 
void SetResourceArns (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestWithResourceArns (const Aws::Vector< Aws::String > &value)
 
SimulateCustomPolicyRequestWithResourceArns (Aws::Vector< Aws::String > &&value)
 
SimulateCustomPolicyRequestAddResourceArns (const Aws::String &value)
 
SimulateCustomPolicyRequestAddResourceArns (Aws::String &&value)
 
SimulateCustomPolicyRequestAddResourceArns (const char *value)
 
const Aws::StringGetResourcePolicy () const
 
bool ResourcePolicyHasBeenSet () const
 
void SetResourcePolicy (const Aws::String &value)
 
void SetResourcePolicy (Aws::String &&value)
 
void SetResourcePolicy (const char *value)
 
SimulateCustomPolicyRequestWithResourcePolicy (const Aws::String &value)
 
SimulateCustomPolicyRequestWithResourcePolicy (Aws::String &&value)
 
SimulateCustomPolicyRequestWithResourcePolicy (const char *value)
 
const Aws::StringGetResourceOwner () const
 
bool ResourceOwnerHasBeenSet () const
 
void SetResourceOwner (const Aws::String &value)
 
void SetResourceOwner (Aws::String &&value)
 
void SetResourceOwner (const char *value)
 
SimulateCustomPolicyRequestWithResourceOwner (const Aws::String &value)
 
SimulateCustomPolicyRequestWithResourceOwner (Aws::String &&value)
 
SimulateCustomPolicyRequestWithResourceOwner (const char *value)
 
const Aws::StringGetCallerArn () const
 
bool CallerArnHasBeenSet () const
 
void SetCallerArn (const Aws::String &value)
 
void SetCallerArn (Aws::String &&value)
 
void SetCallerArn (const char *value)
 
SimulateCustomPolicyRequestWithCallerArn (const Aws::String &value)
 
SimulateCustomPolicyRequestWithCallerArn (Aws::String &&value)
 
SimulateCustomPolicyRequestWithCallerArn (const char *value)
 
const Aws::Vector< ContextEntry > & GetContextEntries () const
 
bool ContextEntriesHasBeenSet () const
 
void SetContextEntries (const Aws::Vector< ContextEntry > &value)
 
void SetContextEntries (Aws::Vector< ContextEntry > &&value)
 
SimulateCustomPolicyRequestWithContextEntries (const Aws::Vector< ContextEntry > &value)
 
SimulateCustomPolicyRequestWithContextEntries (Aws::Vector< ContextEntry > &&value)
 
SimulateCustomPolicyRequestAddContextEntries (const ContextEntry &value)
 
SimulateCustomPolicyRequestAddContextEntries (ContextEntry &&value)
 
const Aws::StringGetResourceHandlingOption () const
 
bool ResourceHandlingOptionHasBeenSet () const
 
void SetResourceHandlingOption (const Aws::String &value)
 
void SetResourceHandlingOption (Aws::String &&value)
 
void SetResourceHandlingOption (const char *value)
 
SimulateCustomPolicyRequestWithResourceHandlingOption (const Aws::String &value)
 
SimulateCustomPolicyRequestWithResourceHandlingOption (Aws::String &&value)
 
SimulateCustomPolicyRequestWithResourceHandlingOption (const char *value)
 
int GetMaxItems () const
 
bool MaxItemsHasBeenSet () const
 
void SetMaxItems (int value)
 
SimulateCustomPolicyRequestWithMaxItems (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
SimulateCustomPolicyRequestWithMarker (const Aws::String &value)
 
SimulateCustomPolicyRequestWithMarker (Aws::String &&value)
 
SimulateCustomPolicyRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::IAM::IAMRequest
virtual ~IAMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::IAM::IAMRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file SimulateCustomPolicyRequest.h.

Constructor & Destructor Documentation

◆ SimulateCustomPolicyRequest()

Aws::IAM::Model::SimulateCustomPolicyRequest::SimulateCustomPolicyRequest ( )

Member Function Documentation

◆ ActionNamesHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ActionNamesHasBeenSet ( ) const
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 444 of file SimulateCustomPolicyRequest.h.

◆ AddActionNames() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddActionNames ( const Aws::String value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 484 of file SimulateCustomPolicyRequest.h.

◆ AddActionNames() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddActionNames ( Aws::String &&  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 492 of file SimulateCustomPolicyRequest.h.

◆ AddActionNames() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddActionNames ( const char *  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 500 of file SimulateCustomPolicyRequest.h.

◆ AddContextEntries() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddContextEntries ( const ContextEntry value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1060 of file SimulateCustomPolicyRequest.h.

◆ AddContextEntries() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddContextEntries ( ContextEntry &&  value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1067 of file SimulateCustomPolicyRequest.h.

◆ AddPermissionsBoundaryPolicyInputList() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPermissionsBoundaryPolicyInputList ( const Aws::String value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 387 of file SimulateCustomPolicyRequest.h.

◆ AddPermissionsBoundaryPolicyInputList() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPermissionsBoundaryPolicyInputList ( Aws::String &&  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 407 of file SimulateCustomPolicyRequest.h.

◆ AddPermissionsBoundaryPolicyInputList() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPermissionsBoundaryPolicyInputList ( const char *  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 427 of file SimulateCustomPolicyRequest.h.

◆ AddPolicyInputList() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPolicyInputList ( const Aws::String value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 200 of file SimulateCustomPolicyRequest.h.

◆ AddPolicyInputList() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPolicyInputList ( Aws::String &&  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 223 of file SimulateCustomPolicyRequest.h.

◆ AddPolicyInputList() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddPolicyInputList ( const char *  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 246 of file SimulateCustomPolicyRequest.h.

◆ AddResourceArns() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddResourceArns ( const Aws::String value)
inline

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.

Definition at line 627 of file SimulateCustomPolicyRequest.h.

◆ AddResourceArns() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddResourceArns ( Aws::String &&  value)
inline

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.

Definition at line 645 of file SimulateCustomPolicyRequest.h.

◆ AddResourceArns() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::AddResourceArns ( const char *  value)
inline

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.

Definition at line 663 of file SimulateCustomPolicyRequest.h.

◆ CallerArnHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::CallerArnHasBeenSet ( ) const
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 950 of file SimulateCustomPolicyRequest.h.

◆ ContextEntriesHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ContextEntriesHasBeenSet ( ) const
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1025 of file SimulateCustomPolicyRequest.h.

◆ DumpBodyToUrl()

void Aws::IAM::Model::SimulateCustomPolicyRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetActionNames()

const Aws::Vector<Aws::String>& Aws::IAM::Model::SimulateCustomPolicyRequest::GetActionNames ( ) const
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 436 of file SimulateCustomPolicyRequest.h.

◆ GetCallerArn()

const Aws::String& Aws::IAM::Model::SimulateCustomPolicyRequest::GetCallerArn ( ) const
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 940 of file SimulateCustomPolicyRequest.h.

◆ GetContextEntries()

const Aws::Vector<ContextEntry>& Aws::IAM::Model::SimulateCustomPolicyRequest::GetContextEntries ( ) const
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1018 of file SimulateCustomPolicyRequest.h.

◆ GetMarker()

const Aws::String& Aws::IAM::Model::SimulateCustomPolicyRequest::GetMarker ( ) const
inline

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.

Definition at line 1350 of file SimulateCustomPolicyRequest.h.

◆ GetMaxItems()

int Aws::IAM::Model::SimulateCustomPolicyRequest::GetMaxItems ( ) const
inline

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, the number of items 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.

Definition at line 1305 of file SimulateCustomPolicyRequest.h.

◆ GetPermissionsBoundaryPolicyInputList()

const Aws::Vector<Aws::String>& Aws::IAM::Model::SimulateCustomPolicyRequest::GetPermissionsBoundaryPolicyInputList ( ) const
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 267 of file SimulateCustomPolicyRequest.h.

◆ GetPolicyInputList()

const Aws::Vector<Aws::String>& Aws::IAM::Model::SimulateCustomPolicyRequest::GetPolicyInputList ( ) const
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 62 of file SimulateCustomPolicyRequest.h.

◆ GetResourceArns()

const Aws::Vector<Aws::String>& Aws::IAM::Model::SimulateCustomPolicyRequest::GetResourceArns ( ) const
inline

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.

Definition at line 519 of file SimulateCustomPolicyRequest.h.

◆ GetResourceHandlingOption()

const Aws::String& Aws::IAM::Model::SimulateCustomPolicyRequest::GetResourceHandlingOption ( ) const
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1096 of file SimulateCustomPolicyRequest.h.

◆ GetResourceOwner()

const Aws::String& Aws::IAM::Model::SimulateCustomPolicyRequest::GetResourceOwner ( ) const
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 803 of file SimulateCustomPolicyRequest.h.

◆ GetResourcePolicy()

const Aws::String& Aws::IAM::Model::SimulateCustomPolicyRequest::GetResourcePolicy ( ) const
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 679 of file SimulateCustomPolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IAM::Model::SimulateCustomPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file SimulateCustomPolicyRequest.h.

◆ MarkerHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 1358 of file SimulateCustomPolicyRequest.h.

◆ MaxItemsHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::MaxItemsHasBeenSet ( ) const
inline

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, the number of items 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.

Definition at line 1317 of file SimulateCustomPolicyRequest.h.

◆ PermissionsBoundaryPolicyInputListHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::PermissionsBoundaryPolicyInputListHasBeenSet ( ) const
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 287 of file SimulateCustomPolicyRequest.h.

◆ PolicyInputListHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::PolicyInputListHasBeenSet ( ) const
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 85 of file SimulateCustomPolicyRequest.h.

◆ ResourceArnsHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ResourceArnsHasBeenSet ( ) const
inline

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.

Definition at line 537 of file SimulateCustomPolicyRequest.h.

◆ ResourceHandlingOptionHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ResourceHandlingOptionHasBeenSet ( ) const
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1124 of file SimulateCustomPolicyRequest.h.

◆ ResourceOwnerHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ResourceOwnerHasBeenSet ( ) const
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 821 of file SimulateCustomPolicyRequest.h.

◆ ResourcePolicyHasBeenSet()

bool Aws::IAM::Model::SimulateCustomPolicyRequest::ResourcePolicyHasBeenSet ( ) const
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 694 of file SimulateCustomPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::IAM::Model::SimulateCustomPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActionNames() [1/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetActionNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 452 of file SimulateCustomPolicyRequest.h.

◆ SetActionNames() [2/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetActionNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 460 of file SimulateCustomPolicyRequest.h.

◆ SetCallerArn() [1/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetCallerArn ( const Aws::String value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 960 of file SimulateCustomPolicyRequest.h.

◆ SetCallerArn() [2/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetCallerArn ( Aws::String &&  value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 970 of file SimulateCustomPolicyRequest.h.

◆ SetCallerArn() [3/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetCallerArn ( const char *  value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 980 of file SimulateCustomPolicyRequest.h.

◆ SetContextEntries() [1/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetContextEntries ( const Aws::Vector< ContextEntry > &  value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1032 of file SimulateCustomPolicyRequest.h.

◆ SetContextEntries() [2/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetContextEntries ( Aws::Vector< ContextEntry > &&  value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1039 of file SimulateCustomPolicyRequest.h.

◆ SetMarker() [1/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 1366 of file SimulateCustomPolicyRequest.h.

◆ SetMarker() [2/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 1374 of file SimulateCustomPolicyRequest.h.

◆ SetMarker() [3/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 1382 of file SimulateCustomPolicyRequest.h.

◆ SetMaxItems()

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetMaxItems ( int  value)
inline

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, the number of items 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.

Definition at line 1329 of file SimulateCustomPolicyRequest.h.

◆ SetPermissionsBoundaryPolicyInputList() [1/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetPermissionsBoundaryPolicyInputList ( const Aws::Vector< Aws::String > &  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 307 of file SimulateCustomPolicyRequest.h.

◆ SetPermissionsBoundaryPolicyInputList() [2/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetPermissionsBoundaryPolicyInputList ( Aws::Vector< Aws::String > &&  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 327 of file SimulateCustomPolicyRequest.h.

◆ SetPolicyInputList() [1/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetPolicyInputList ( const Aws::Vector< Aws::String > &  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 108 of file SimulateCustomPolicyRequest.h.

◆ SetPolicyInputList() [2/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetPolicyInputList ( Aws::Vector< Aws::String > &&  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 131 of file SimulateCustomPolicyRequest.h.

◆ SetResourceArns() [1/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceArns ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 555 of file SimulateCustomPolicyRequest.h.

◆ SetResourceArns() [2/2]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceArns ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 573 of file SimulateCustomPolicyRequest.h.

◆ SetResourceHandlingOption() [1/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceHandlingOption ( const Aws::String value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1152 of file SimulateCustomPolicyRequest.h.

◆ SetResourceHandlingOption() [2/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceHandlingOption ( Aws::String &&  value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1180 of file SimulateCustomPolicyRequest.h.

◆ SetResourceHandlingOption() [3/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceHandlingOption ( const char *  value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1208 of file SimulateCustomPolicyRequest.h.

◆ SetResourceOwner() [1/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceOwner ( const Aws::String value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 839 of file SimulateCustomPolicyRequest.h.

◆ SetResourceOwner() [2/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceOwner ( Aws::String &&  value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 857 of file SimulateCustomPolicyRequest.h.

◆ SetResourceOwner() [3/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourceOwner ( const char *  value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 875 of file SimulateCustomPolicyRequest.h.

◆ SetResourcePolicy() [1/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourcePolicy ( const Aws::String value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 709 of file SimulateCustomPolicyRequest.h.

◆ SetResourcePolicy() [2/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourcePolicy ( Aws::String &&  value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 724 of file SimulateCustomPolicyRequest.h.

◆ SetResourcePolicy() [3/3]

void Aws::IAM::Model::SimulateCustomPolicyRequest::SetResourcePolicy ( const char *  value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 739 of file SimulateCustomPolicyRequest.h.

◆ WithActionNames() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithActionNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 468 of file SimulateCustomPolicyRequest.h.

◆ WithActionNames() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithActionNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

Definition at line 476 of file SimulateCustomPolicyRequest.h.

◆ WithCallerArn() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithCallerArn ( const Aws::String value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 990 of file SimulateCustomPolicyRequest.h.

◆ WithCallerArn() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithCallerArn ( Aws::String &&  value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 1000 of file SimulateCustomPolicyRequest.h.

◆ WithCallerArn() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithCallerArn ( const char *  value)
inline

The ARN of the IAM user that you want to use as the simulated caller of the API operations. 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.

Definition at line 1010 of file SimulateCustomPolicyRequest.h.

◆ WithContextEntries() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithContextEntries ( const Aws::Vector< ContextEntry > &  value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1046 of file SimulateCustomPolicyRequest.h.

◆ WithContextEntries() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithContextEntries ( Aws::Vector< ContextEntry > &&  value)
inline

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 permissions policies, the corresponding value is supplied.

Definition at line 1053 of file SimulateCustomPolicyRequest.h.

◆ WithMarker() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 1390 of file SimulateCustomPolicyRequest.h.

◆ WithMarker() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 1398 of file SimulateCustomPolicyRequest.h.

◆ WithMarker() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 1406 of file SimulateCustomPolicyRequest.h.

◆ WithMaxItems()

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithMaxItems ( int  value)
inline

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, the number of items 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.

Definition at line 1341 of file SimulateCustomPolicyRequest.h.

◆ WithPermissionsBoundaryPolicyInputList() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithPermissionsBoundaryPolicyInputList ( const Aws::Vector< Aws::String > &  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 347 of file SimulateCustomPolicyRequest.h.

◆ WithPermissionsBoundaryPolicyInputList() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithPermissionsBoundaryPolicyInputList ( Aws::Vector< Aws::String > &&  value)
inline

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions Boundaries for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 367 of file SimulateCustomPolicyRequest.h.

◆ WithPolicyInputList() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithPolicyInputList ( const Aws::Vector< Aws::String > &  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 154 of file SimulateCustomPolicyRequest.h.

◆ WithPolicyInputList() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithPolicyInputList ( Aws::Vector< Aws::String > &&  value)
inline

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 API operations. In other words, do not use policies designed 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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 177 of file SimulateCustomPolicyRequest.h.

◆ WithResourceArns() [1/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceArns ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 591 of file SimulateCustomPolicyRequest.h.

◆ WithResourceArns() [2/2]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceArns ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 609 of file SimulateCustomPolicyRequest.h.

◆ WithResourceHandlingOption() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceHandlingOption ( const Aws::String value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1236 of file SimulateCustomPolicyRequest.h.

◆ WithResourceHandlingOption() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceHandlingOption ( Aws::String &&  value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1264 of file SimulateCustomPolicyRequest.h.

◆ WithResourceHandlingOption() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceHandlingOption ( const char *  value)
inline

Specifies the type of simulation to run. Different API operations 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 Amazon 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

Definition at line 1292 of file SimulateCustomPolicyRequest.h.

◆ WithResourceOwner() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceOwner ( const Aws::String value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 893 of file SimulateCustomPolicyRequest.h.

◆ WithResourceOwner() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceOwner ( Aws::String &&  value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 911 of file SimulateCustomPolicyRequest.h.

◆ WithResourceOwner() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourceOwner ( const char *  value)
inline

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include 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.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

Definition at line 929 of file SimulateCustomPolicyRequest.h.

◆ WithResourcePolicy() [1/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourcePolicy ( const Aws::String value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 754 of file SimulateCustomPolicyRequest.h.

◆ WithResourcePolicy() [2/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourcePolicy ( Aws::String &&  value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 769 of file SimulateCustomPolicyRequest.h.

◆ WithResourcePolicy() [3/3]

SimulateCustomPolicyRequest& Aws::IAM::Model::SimulateCustomPolicyRequest::WithResourcePolicy ( const char *  value)
inline

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 the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 784 of file SimulateCustomPolicyRequest.h.


The documentation for this class was generated from the following file: