#include <PutBucketPolicyRequest.h>

Inheritance diagram for Aws::S3Control::Model::PutBucketPolicyRequest:

Public Member Functions
	PutBucketPolicyRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

bool	ShouldComputeContentMd5 () const override

const Aws::String &	GetAccountId () const

bool	AccountIdHasBeenSet () const

void	SetAccountId (const Aws::String &value)

void	SetAccountId (Aws::String &&value)

void	SetAccountId (const char *value)

PutBucketPolicyRequest &	WithAccountId (const Aws::String &value)

PutBucketPolicyRequest &	WithAccountId (Aws::String &&value)

PutBucketPolicyRequest &	WithAccountId (const char *value)

const Aws::String &	GetBucket () const

bool	BucketHasBeenSet () const

void	SetBucket (const Aws::String &value)

void	SetBucket (Aws::String &&value)

void	SetBucket (const char *value)

PutBucketPolicyRequest &	WithBucket (const Aws::String &value)

PutBucketPolicyRequest &	WithBucket (Aws::String &&value)

PutBucketPolicyRequest &	WithBucket (const char *value)

bool	GetConfirmRemoveSelfBucketAccess () const

bool	ConfirmRemoveSelfBucketAccessHasBeenSet () const

void	SetConfirmRemoveSelfBucketAccess (bool value)

PutBucketPolicyRequest &	WithConfirmRemoveSelfBucketAccess (bool value)

const Aws::String &	GetPolicy () const

bool	PolicyHasBeenSet () const

void	SetPolicy (const Aws::String &value)

void	SetPolicy (Aws::String &&value)

void	SetPolicy (const char *value)

PutBucketPolicyRequest &	WithPolicy (const Aws::String &value)

PutBucketPolicyRequest &	WithPolicy (Aws::String &&value)

PutBucketPolicyRequest &	WithPolicy (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 PutBucketPolicyRequest.h.

Constructor & Destructor Documentation

◆ PutBucketPolicyRequest()

Aws::S3Control::Model::PutBucketPolicyRequest::PutBucketPolicyRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::S3Control::Model::PutBucketPolicyRequest::AccountIdHasBeenSet ( ) const

inline

The AWS account ID of the Outposts bucket.

Definition at line 47 of file PutBucketPolicyRequest.h.

◆ BucketHasBeenSet()

bool Aws::S3Control::Model::PutBucketPolicyRequest::BucketHasBeenSet ( ) const

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 106 of file PutBucketPolicyRequest.h.

◆ ConfirmRemoveSelfBucketAccessHasBeenSet()

bool Aws::S3Control::Model::PutBucketPolicyRequest::ConfirmRemoveSelfBucketAccessHasBeenSet ( ) const

inline

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

Definition at line 205 of file PutBucketPolicyRequest.h.

◆ GetAccountId()

const Aws::String& Aws::S3Control::Model::PutBucketPolicyRequest::GetAccountId ( ) const

inline

The AWS account ID of the Outposts bucket.

Definition at line 42 of file PutBucketPolicyRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Control::Model::PutBucketPolicyRequest::GetBucket ( ) const

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 92 of file PutBucketPolicyRequest.h.

◆ GetConfirmRemoveSelfBucketAccess()

bool Aws::S3Control::Model::PutBucketPolicyRequest::GetConfirmRemoveSelfBucketAccess ( ) const

inline

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

Definition at line 198 of file PutBucketPolicyRequest.h.

◆ GetPolicy()

const Aws::String& Aws::S3Control::Model::PutBucketPolicyRequest::GetPolicy ( ) const

inline

The bucket policy as a JSON document.

Definition at line 225 of file PutBucketPolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Control::Model::PutBucketPolicyRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

virtual const char* Aws::S3Control::Model::PutBucketPolicyRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file PutBucketPolicyRequest.h.

◆ PolicyHasBeenSet()

bool Aws::S3Control::Model::PutBucketPolicyRequest::PolicyHasBeenSet ( ) const

inline

The bucket policy as a JSON document.

Definition at line 230 of file PutBucketPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Control::Model::PutBucketPolicyRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetAccountId ( const Aws::String & value )

inline

The AWS account ID of the Outposts bucket.

Definition at line 52 of file PutBucketPolicyRequest.h.

◆ SetAccountId() [2/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetAccountId ( Aws::String && value )

inline

The AWS account ID of the Outposts bucket.

Definition at line 57 of file PutBucketPolicyRequest.h.

◆ SetAccountId() [3/3]

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

inline

The AWS account ID of the Outposts bucket.

Definition at line 62 of file PutBucketPolicyRequest.h.

◆ SetBucket() [1/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetBucket ( const Aws::String & value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 120 of file PutBucketPolicyRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetBucket ( Aws::String && value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 134 of file PutBucketPolicyRequest.h.

◆ SetBucket() [3/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetBucket ( const char * value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 148 of file PutBucketPolicyRequest.h.

◆ SetConfirmRemoveSelfBucketAccess()

void Aws::S3Control::Model::PutBucketPolicyRequest::SetConfirmRemoveSelfBucketAccess ( bool value )

inline

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

Definition at line 212 of file PutBucketPolicyRequest.h.

◆ SetPolicy() [1/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetPolicy ( const Aws::String & value )

inline

The bucket policy as a JSON document.

Definition at line 235 of file PutBucketPolicyRequest.h.

◆ SetPolicy() [2/3]

void Aws::S3Control::Model::PutBucketPolicyRequest::SetPolicy ( Aws::String && value )

inline

The bucket policy as a JSON document.

Definition at line 240 of file PutBucketPolicyRequest.h.

◆ SetPolicy() [3/3]

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

inline

The bucket policy as a JSON document.

Definition at line 245 of file PutBucketPolicyRequest.h.

◆ ShouldComputeContentMd5()

bool Aws::S3Control::Model::PutBucketPolicyRequest::ShouldComputeContentMd5 ( ) const

inlineoverridevirtual

If this is set to true, content-md5 needs to be computed and set on the request

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 36 of file PutBucketPolicyRequest.h.

◆ WithAccountId() [1/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithAccountId ( const Aws::String & value )

inline

The AWS account ID of the Outposts bucket.

Definition at line 67 of file PutBucketPolicyRequest.h.

◆ WithAccountId() [2/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithAccountId ( Aws::String && value )

inline

The AWS account ID of the Outposts bucket.

Definition at line 72 of file PutBucketPolicyRequest.h.

◆ WithAccountId() [3/3]

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

inline

The AWS account ID of the Outposts bucket.

Definition at line 77 of file PutBucketPolicyRequest.h.

◆ WithBucket() [1/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithBucket ( const Aws::String & value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 162 of file PutBucketPolicyRequest.h.

◆ WithBucket() [2/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithBucket ( Aws::String && value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 176 of file PutBucketPolicyRequest.h.

◆ WithBucket() [3/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithBucket ( const char * value )

inline

Specifies the bucket.

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 bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports 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/bucket/reports. The value must be URL encoded.

Definition at line 190 of file PutBucketPolicyRequest.h.

◆ WithConfirmRemoveSelfBucketAccess()

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithConfirmRemoveSelfBucketAccess ( bool value )

inline

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

Definition at line 219 of file PutBucketPolicyRequest.h.

◆ WithPolicy() [1/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithPolicy ( const Aws::String & value )

inline

The bucket policy as a JSON document.

Definition at line 250 of file PutBucketPolicyRequest.h.

◆ WithPolicy() [2/3]

PutBucketPolicyRequest& Aws::S3Control::Model::PutBucketPolicyRequest::WithPolicy ( Aws::String && value )

inline

The bucket policy as a JSON document.

Definition at line 255 of file PutBucketPolicyRequest.h.

◆ WithPolicy() [3/3]

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

inline

The bucket policy as a JSON document.

Definition at line 260 of file PutBucketPolicyRequest.h.

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

aws-cpp-sdk-s3control/include/aws/s3control/model/PutBucketPolicyRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PutBucketPolicyRequest()

Member Function Documentation

◆ AccountIdHasBeenSet()

◆ BucketHasBeenSet()

◆ ConfirmRemoveSelfBucketAccessHasBeenSet()

◆ GetAccountId()

◆ GetBucket()

◆ GetConfirmRemoveSelfBucketAccess()

◆ GetPolicy()

◆ GetRequestSpecificHeaders()

◆ GetServiceRequestName()

◆ PolicyHasBeenSet()

◆ SerializePayload()

◆ SetAccountId() [1/3]

◆ SetAccountId() [2/3]

◆ SetAccountId() [3/3]

◆ SetBucket() [1/3]

◆ SetBucket() [2/3]

◆ SetBucket() [3/3]

◆ SetConfirmRemoveSelfBucketAccess()

◆ SetPolicy() [1/3]

◆ SetPolicy() [2/3]

◆ SetPolicy() [3/3]

◆ ShouldComputeContentMd5()

◆ WithAccountId() [1/3]

◆ WithAccountId() [2/3]

◆ WithAccountId() [3/3]

◆ WithBucket() [1/3]

◆ WithBucket() [2/3]

◆ WithBucket() [3/3]

◆ WithConfirmRemoveSelfBucketAccess()

◆ WithPolicy() [1/3]

◆ WithPolicy() [2/3]

◆ WithPolicy() [3/3]