AWS SDK for C++  1.9.161
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecretsManager::Model::PutResourcePolicyRequest Class Reference

#include <PutResourcePolicyRequest.h>

+ Inheritance diagram for Aws::SecretsManager::Model::PutResourcePolicyRequest:

Public Member Functions

 PutResourcePolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSecretId () const
 
bool SecretIdHasBeenSet () const
 
void SetSecretId (const Aws::String &value)
 
void SetSecretId (Aws::String &&value)
 
void SetSecretId (const char *value)
 
PutResourcePolicyRequestWithSecretId (const Aws::String &value)
 
PutResourcePolicyRequestWithSecretId (Aws::String &&value)
 
PutResourcePolicyRequestWithSecretId (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)
 
PutResourcePolicyRequestWithResourcePolicy (const Aws::String &value)
 
PutResourcePolicyRequestWithResourcePolicy (Aws::String &&value)
 
PutResourcePolicyRequestWithResourcePolicy (const char *value)
 
bool GetBlockPublicPolicy () const
 
bool BlockPublicPolicyHasBeenSet () const
 
void SetBlockPublicPolicy (bool value)
 
PutResourcePolicyRequestWithBlockPublicPolicy (bool value)
 
- Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual ~SecretsManagerRequest ()
 
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 PutResourcePolicyRequest.h.

Constructor & Destructor Documentation

◆ PutResourcePolicyRequest()

Aws::SecretsManager::Model::PutResourcePolicyRequest::PutResourcePolicyRequest ( )

Member Function Documentation

◆ BlockPublicPolicyHasBeenSet()

bool Aws::SecretsManager::Model::PutResourcePolicyRequest::BlockPublicPolicyHasBeenSet ( ) const
inline

(Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Definition at line 195 of file PutResourcePolicyRequest.h.

◆ GetBlockPublicPolicy()

bool Aws::SecretsManager::Model::PutResourcePolicyRequest::GetBlockPublicPolicy ( ) const
inline

(Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Definition at line 188 of file PutResourcePolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::PutResourcePolicyRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetResourcePolicy()

const Aws::String& Aws::SecretsManager::Model::PutResourcePolicyRequest::GetResourcePolicy ( ) const
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 103 of file PutResourcePolicyRequest.h.

◆ GetSecretId()

const Aws::String& Aws::SecretsManager::Model::PutResourcePolicyRequest::GetSecretId ( ) const
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 42 of file PutResourcePolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::PutResourcePolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file PutResourcePolicyRequest.h.

◆ ResourcePolicyHasBeenSet()

bool Aws::SecretsManager::Model::PutResourcePolicyRequest::ResourcePolicyHasBeenSet ( ) const
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 114 of file PutResourcePolicyRequest.h.

◆ SecretIdHasBeenSet()

bool Aws::SecretsManager::Model::PutResourcePolicyRequest::SecretIdHasBeenSet ( ) const
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 49 of file PutResourcePolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::PutResourcePolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBlockPublicPolicy()

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetBlockPublicPolicy ( bool  value)
inline

(Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Definition at line 202 of file PutResourcePolicyRequest.h.

◆ SetResourcePolicy() [1/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetResourcePolicy ( Aws::String &&  value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 136 of file PutResourcePolicyRequest.h.

◆ SetResourcePolicy() [2/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetResourcePolicy ( const Aws::String value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 125 of file PutResourcePolicyRequest.h.

◆ SetResourcePolicy() [3/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetResourcePolicy ( const char *  value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 147 of file PutResourcePolicyRequest.h.

◆ SetSecretId() [1/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetSecretId ( Aws::String &&  value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 63 of file PutResourcePolicyRequest.h.

◆ SetSecretId() [2/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetSecretId ( const Aws::String value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 56 of file PutResourcePolicyRequest.h.

◆ SetSecretId() [3/3]

void Aws::SecretsManager::Model::PutResourcePolicyRequest::SetSecretId ( const char *  value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 70 of file PutResourcePolicyRequest.h.

◆ WithBlockPublicPolicy()

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithBlockPublicPolicy ( bool  value)
inline

(Optional) If you set the parameter, BlockPublicPolicy to true, then you block resource-based policies that allow broad access to the secret.

Definition at line 209 of file PutResourcePolicyRequest.h.

◆ WithResourcePolicy() [1/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithResourcePolicy ( Aws::String &&  value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 169 of file PutResourcePolicyRequest.h.

◆ WithResourcePolicy() [2/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithResourcePolicy ( const Aws::String value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 158 of file PutResourcePolicyRequest.h.

◆ WithResourcePolicy() [3/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithResourcePolicy ( const char *  value)
inline

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.

Definition at line 180 of file PutResourcePolicyRequest.h.

◆ WithSecretId() [1/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithSecretId ( Aws::String &&  value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 84 of file PutResourcePolicyRequest.h.

◆ WithSecretId() [2/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithSecretId ( const Aws::String value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 77 of file PutResourcePolicyRequest.h.

◆ WithSecretId() [3/3]

PutResourcePolicyRequest& Aws::SecretsManager::Model::PutResourcePolicyRequest::WithSecretId ( const char *  value)
inline

Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 91 of file PutResourcePolicyRequest.h.


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