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

#include <CreateAccessPointRequest.h>

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

Public Member Functions

 CreateAccessPointRequest ()
 
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)
 
CreateAccessPointRequestWithAccountId (const Aws::String &value)
 
CreateAccessPointRequestWithAccountId (Aws::String &&value)
 
CreateAccessPointRequestWithAccountId (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)
 
CreateAccessPointRequestWithName (const Aws::String &value)
 
CreateAccessPointRequestWithName (Aws::String &&value)
 
CreateAccessPointRequestWithName (const char *value)
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
CreateAccessPointRequestWithBucket (const Aws::String &value)
 
CreateAccessPointRequestWithBucket (Aws::String &&value)
 
CreateAccessPointRequestWithBucket (const char *value)
 
const VpcConfigurationGetVpcConfiguration () const
 
bool VpcConfigurationHasBeenSet () const
 
void SetVpcConfiguration (const VpcConfiguration &value)
 
void SetVpcConfiguration (VpcConfiguration &&value)
 
CreateAccessPointRequestWithVpcConfiguration (const VpcConfiguration &value)
 
CreateAccessPointRequestWithVpcConfiguration (VpcConfiguration &&value)
 
const PublicAccessBlockConfigurationGetPublicAccessBlockConfiguration () const
 
bool PublicAccessBlockConfigurationHasBeenSet () const
 
void SetPublicAccessBlockConfiguration (const PublicAccessBlockConfiguration &value)
 
void SetPublicAccessBlockConfiguration (PublicAccessBlockConfiguration &&value)
 
CreateAccessPointRequestWithPublicAccessBlockConfiguration (const PublicAccessBlockConfiguration &value)
 
CreateAccessPointRequestWithPublicAccessBlockConfiguration (PublicAccessBlockConfiguration &&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 23 of file CreateAccessPointRequest.h.

Constructor & Destructor Documentation

◆ CreateAccessPointRequest()

Aws::S3Control::Model::CreateAccessPointRequest::CreateAccessPointRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 49 of file CreateAccessPointRequest.h.

◆ BucketHasBeenSet()

bool Aws::S3Control::Model::CreateAccessPointRequest::BucketHasBeenSet ( ) const
inline

The name of the bucket that you want to associate this access point with.

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 157 of file CreateAccessPointRequest.h.

◆ GetAccountId()

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 43 of file CreateAccessPointRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Control::Model::CreateAccessPointRequest::GetBucket ( ) const
inline

The name of the bucket that you want to associate this access point with.

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 142 of file CreateAccessPointRequest.h.

◆ GetName()

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

The name you want to assign to this access point.

Definition at line 91 of file CreateAccessPointRequest.h.

◆ GetPublicAccessBlockConfiguration()

const PublicAccessBlockConfiguration& Aws::S3Control::Model::CreateAccessPointRequest::GetPublicAccessBlockConfiguration ( ) const
inline

Definition at line 300 of file CreateAccessPointRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateAccessPointRequest.h.

◆ GetVpcConfiguration()

const VpcConfiguration& Aws::S3Control::Model::CreateAccessPointRequest::GetVpcConfiguration ( ) const
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 256 of file CreateAccessPointRequest.h.

◆ NameHasBeenSet()

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

The name you want to assign to this access point.

Definition at line 96 of file CreateAccessPointRequest.h.

◆ PublicAccessBlockConfigurationHasBeenSet()

bool Aws::S3Control::Model::CreateAccessPointRequest::PublicAccessBlockConfigurationHasBeenSet ( ) const
inline

Definition at line 303 of file CreateAccessPointRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 55 of file CreateAccessPointRequest.h.

◆ SetAccountId() [2/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 61 of file CreateAccessPointRequest.h.

◆ SetAccountId() [3/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 67 of file CreateAccessPointRequest.h.

◆ SetBucket() [1/3]

void Aws::S3Control::Model::CreateAccessPointRequest::SetBucket ( const Aws::String value)
inline

The name of the bucket that you want to associate this access point with.

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 172 of file CreateAccessPointRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Control::Model::CreateAccessPointRequest::SetBucket ( Aws::String &&  value)
inline

The name of the bucket that you want to associate this access point with.

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 187 of file CreateAccessPointRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket that you want to associate this access point with.

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 202 of file CreateAccessPointRequest.h.

◆ SetName() [1/3]

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

The name you want to assign to this access point.

Definition at line 101 of file CreateAccessPointRequest.h.

◆ SetName() [2/3]

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

The name you want to assign to this access point.

Definition at line 106 of file CreateAccessPointRequest.h.

◆ SetName() [3/3]

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

The name you want to assign to this access point.

Definition at line 111 of file CreateAccessPointRequest.h.

◆ SetPublicAccessBlockConfiguration() [1/2]

void Aws::S3Control::Model::CreateAccessPointRequest::SetPublicAccessBlockConfiguration ( const PublicAccessBlockConfiguration value)
inline

Definition at line 306 of file CreateAccessPointRequest.h.

◆ SetPublicAccessBlockConfiguration() [2/2]

void Aws::S3Control::Model::CreateAccessPointRequest::SetPublicAccessBlockConfiguration ( PublicAccessBlockConfiguration &&  value)
inline

Definition at line 309 of file CreateAccessPointRequest.h.

◆ SetVpcConfiguration() [1/2]

void Aws::S3Control::Model::CreateAccessPointRequest::SetVpcConfiguration ( const VpcConfiguration value)
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 272 of file CreateAccessPointRequest.h.

◆ SetVpcConfiguration() [2/2]

void Aws::S3Control::Model::CreateAccessPointRequest::SetVpcConfiguration ( VpcConfiguration &&  value)
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 280 of file CreateAccessPointRequest.h.

◆ VpcConfigurationHasBeenSet()

bool Aws::S3Control::Model::CreateAccessPointRequest::VpcConfigurationHasBeenSet ( ) const
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 264 of file CreateAccessPointRequest.h.

◆ WithAccountId() [1/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 73 of file CreateAccessPointRequest.h.

◆ WithAccountId() [2/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 79 of file CreateAccessPointRequest.h.

◆ WithAccountId() [3/3]

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

The AWS account ID for the owner of the bucket for which you want to create an access point.

Definition at line 85 of file CreateAccessPointRequest.h.

◆ WithBucket() [1/3]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithBucket ( const Aws::String value)
inline

The name of the bucket that you want to associate this access point with.

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 217 of file CreateAccessPointRequest.h.

◆ WithBucket() [2/3]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithBucket ( Aws::String &&  value)
inline

The name of the bucket that you want to associate this access point with.

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 232 of file CreateAccessPointRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket that you want to associate this access point with.

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 247 of file CreateAccessPointRequest.h.

◆ WithName() [1/3]

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

The name you want to assign to this access point.

Definition at line 116 of file CreateAccessPointRequest.h.

◆ WithName() [2/3]

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

The name you want to assign to this access point.

Definition at line 121 of file CreateAccessPointRequest.h.

◆ WithName() [3/3]

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

The name you want to assign to this access point.

Definition at line 126 of file CreateAccessPointRequest.h.

◆ WithPublicAccessBlockConfiguration() [1/2]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithPublicAccessBlockConfiguration ( const PublicAccessBlockConfiguration value)
inline

Definition at line 312 of file CreateAccessPointRequest.h.

◆ WithPublicAccessBlockConfiguration() [2/2]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithPublicAccessBlockConfiguration ( PublicAccessBlockConfiguration &&  value)
inline

Definition at line 315 of file CreateAccessPointRequest.h.

◆ WithVpcConfiguration() [1/2]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithVpcConfiguration ( const VpcConfiguration value)
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 288 of file CreateAccessPointRequest.h.

◆ WithVpcConfiguration() [2/2]

CreateAccessPointRequest& Aws::S3Control::Model::CreateAccessPointRequest::WithVpcConfiguration ( VpcConfiguration &&  value)
inline

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Definition at line 296 of file CreateAccessPointRequest.h.


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