AWS SDK for C++  1.8.98
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Control::Model::PutAccessPointPolicyRequest Class Reference

#include <PutAccessPointPolicyRequest.h>

+ Inheritance diagram for Aws::S3Control::Model::PutAccessPointPolicyRequest:

Public Member Functions

 PutAccessPointPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
PutAccessPointPolicyRequestWithAccountId (const Aws::String &value)
 
PutAccessPointPolicyRequestWithAccountId (Aws::String &&value)
 
PutAccessPointPolicyRequestWithAccountId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutAccessPointPolicyRequestWithName (const Aws::String &value)
 
PutAccessPointPolicyRequestWithName (Aws::String &&value)
 
PutAccessPointPolicyRequestWithName (const char *value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
PutAccessPointPolicyRequestWithPolicy (const Aws::String &value)
 
PutAccessPointPolicyRequestWithPolicy (Aws::String &&value)
 
PutAccessPointPolicyRequestWithPolicy (const char *value)
 
- Public Member Functions inherited from Aws::S3Control::S3ControlRequest
virtual ~S3ControlRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file PutAccessPointPolicyRequest.h.

Constructor & Destructor Documentation

◆ PutAccessPointPolicyRequest()

Aws::S3Control::Model::PutAccessPointPolicyRequest::PutAccessPointPolicyRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::S3Control::Model::PutAccessPointPolicyRequest::AccountIdHasBeenSet ( ) const
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 47 of file PutAccessPointPolicyRequest.h.

◆ GetAccountId()

const Aws::String& Aws::S3Control::Model::PutAccessPointPolicyRequest::GetAccountId ( ) const
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 41 of file PutAccessPointPolicyRequest.h.

◆ GetName()

const Aws::String& Aws::S3Control::Model::PutAccessPointPolicyRequest::GetName ( ) const
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 99 of file PutAccessPointPolicyRequest.h.

◆ GetPolicy()

const Aws::String& Aws::S3Control::Model::PutAccessPointPolicyRequest::GetPolicy ( ) const
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 214 of file PutAccessPointPolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Control::Model::PutAccessPointPolicyRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

virtual const char* Aws::S3Control::Model::PutAccessPointPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file PutAccessPointPolicyRequest.h.

◆ NameHasBeenSet()

bool Aws::S3Control::Model::PutAccessPointPolicyRequest::NameHasBeenSet ( ) const
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 114 of file PutAccessPointPolicyRequest.h.

◆ PolicyHasBeenSet()

bool Aws::S3Control::Model::PutAccessPointPolicyRequest::PolicyHasBeenSet ( ) const
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 223 of file PutAccessPointPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Control::Model::PutAccessPointPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetAccountId ( const Aws::String value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 53 of file PutAccessPointPolicyRequest.h.

◆ SetAccountId() [2/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetAccountId ( Aws::String &&  value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 59 of file PutAccessPointPolicyRequest.h.

◆ SetAccountId() [3/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetAccountId ( const char *  value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 65 of file PutAccessPointPolicyRequest.h.

◆ SetName() [1/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetName ( const Aws::String value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 129 of file PutAccessPointPolicyRequest.h.

◆ SetName() [2/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetName ( Aws::String &&  value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 144 of file PutAccessPointPolicyRequest.h.

◆ SetName() [3/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetName ( const char *  value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 159 of file PutAccessPointPolicyRequest.h.

◆ SetPolicy() [1/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetPolicy ( const Aws::String value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 232 of file PutAccessPointPolicyRequest.h.

◆ SetPolicy() [2/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetPolicy ( Aws::String &&  value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 241 of file PutAccessPointPolicyRequest.h.

◆ SetPolicy() [3/3]

void Aws::S3Control::Model::PutAccessPointPolicyRequest::SetPolicy ( const char *  value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 250 of file PutAccessPointPolicyRequest.h.

◆ WithAccountId() [1/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithAccountId ( const Aws::String value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 71 of file PutAccessPointPolicyRequest.h.

◆ WithAccountId() [2/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithAccountId ( Aws::String &&  value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 77 of file PutAccessPointPolicyRequest.h.

◆ WithAccountId() [3/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithAccountId ( const char *  value)
inline

The AWS account ID for owner of the bucket associated with the specified access point.

Definition at line 83 of file PutAccessPointPolicyRequest.h.

◆ WithName() [1/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithName ( const Aws::String value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 174 of file PutAccessPointPolicyRequest.h.

◆ WithName() [2/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithName ( Aws::String &&  value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 189 of file PutAccessPointPolicyRequest.h.

◆ WithName() [3/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithName ( const char *  value)
inline

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Definition at line 204 of file PutAccessPointPolicyRequest.h.

◆ WithPolicy() [1/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithPolicy ( const Aws::String value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 259 of file PutAccessPointPolicyRequest.h.

◆ WithPolicy() [2/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithPolicy ( Aws::String &&  value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 268 of file PutAccessPointPolicyRequest.h.

◆ WithPolicy() [3/3]

PutAccessPointPolicyRequest& Aws::S3Control::Model::PutAccessPointPolicyRequest::WithPolicy ( const char *  value)
inline

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 277 of file PutAccessPointPolicyRequest.h.


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