AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudWatchEvents::Model::PutPermissionRequest Class Reference

#include <PutPermissionRequest.h>

+ Inheritance diagram for Aws::CloudWatchEvents::Model::PutPermissionRequest:

Public Member Functions

 PutPermissionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetEventBusName () const
 
bool EventBusNameHasBeenSet () const
 
void SetEventBusName (const Aws::String &value)
 
void SetEventBusName (Aws::String &&value)
 
void SetEventBusName (const char *value)
 
PutPermissionRequestWithEventBusName (const Aws::String &value)
 
PutPermissionRequestWithEventBusName (Aws::String &&value)
 
PutPermissionRequestWithEventBusName (const char *value)
 
const Aws::StringGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const Aws::String &value)
 
void SetAction (Aws::String &&value)
 
void SetAction (const char *value)
 
PutPermissionRequestWithAction (const Aws::String &value)
 
PutPermissionRequestWithAction (Aws::String &&value)
 
PutPermissionRequestWithAction (const char *value)
 
const Aws::StringGetPrincipal () const
 
bool PrincipalHasBeenSet () const
 
void SetPrincipal (const Aws::String &value)
 
void SetPrincipal (Aws::String &&value)
 
void SetPrincipal (const char *value)
 
PutPermissionRequestWithPrincipal (const Aws::String &value)
 
PutPermissionRequestWithPrincipal (Aws::String &&value)
 
PutPermissionRequestWithPrincipal (const char *value)
 
const Aws::StringGetStatementId () const
 
bool StatementIdHasBeenSet () const
 
void SetStatementId (const Aws::String &value)
 
void SetStatementId (Aws::String &&value)
 
void SetStatementId (const char *value)
 
PutPermissionRequestWithStatementId (const Aws::String &value)
 
PutPermissionRequestWithStatementId (Aws::String &&value)
 
PutPermissionRequestWithStatementId (const char *value)
 
const ConditionGetCondition () const
 
bool ConditionHasBeenSet () const
 
void SetCondition (const Condition &value)
 
void SetCondition (Condition &&value)
 
PutPermissionRequestWithCondition (const Condition &value)
 
PutPermissionRequestWithCondition (Condition &&value)
 
- Public Member Functions inherited from Aws::CloudWatchEvents::CloudWatchEventsRequest
virtual ~CloudWatchEventsRequest ()
 
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 22 of file PutPermissionRequest.h.

Constructor & Destructor Documentation

◆ PutPermissionRequest()

Aws::CloudWatchEvents::Model::PutPermissionRequest::PutPermissionRequest ( )

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::CloudWatchEvents::Model::PutPermissionRequest::ActionHasBeenSet ( ) const
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 97 of file PutPermissionRequest.h.

◆ ConditionHasBeenSet()

bool Aws::CloudWatchEvents::Model::PutPermissionRequest::ConditionHasBeenSet ( ) const
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 324 of file PutPermissionRequest.h.

◆ EventBusNameHasBeenSet()

bool Aws::CloudWatchEvents::Model::PutPermissionRequest::EventBusNameHasBeenSet ( ) const
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 48 of file PutPermissionRequest.h.

◆ GetAction()

const Aws::String& Aws::CloudWatchEvents::Model::PutPermissionRequest::GetAction ( ) const
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 91 of file PutPermissionRequest.h.

◆ GetCondition()

const Condition& Aws::CloudWatchEvents::Model::PutPermissionRequest::GetCondition ( ) const
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 310 of file PutPermissionRequest.h.

◆ GetEventBusName()

const Aws::String& Aws::CloudWatchEvents::Model::PutPermissionRequest::GetEventBusName ( ) const
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 42 of file PutPermissionRequest.h.

◆ GetPrincipal()

const Aws::String& Aws::CloudWatchEvents::Model::PutPermissionRequest::GetPrincipal ( ) const
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 146 of file PutPermissionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudWatchEvents::Model::PutPermissionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CloudWatchEvents::Model::PutPermissionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file PutPermissionRequest.h.

◆ GetStatementId()

const Aws::String& Aws::CloudWatchEvents::Model::PutPermissionRequest::GetStatementId ( ) const
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 239 of file PutPermissionRequest.h.

◆ PrincipalHasBeenSet()

bool Aws::CloudWatchEvents::Model::PutPermissionRequest::PrincipalHasBeenSet ( ) const
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 158 of file PutPermissionRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudWatchEvents::Model::PutPermissionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAction() [1/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetAction ( const Aws::String value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 103 of file PutPermissionRequest.h.

◆ SetAction() [2/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetAction ( Aws::String &&  value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 109 of file PutPermissionRequest.h.

◆ SetAction() [3/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetAction ( const char *  value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 115 of file PutPermissionRequest.h.

◆ SetCondition() [1/2]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetCondition ( const Condition value)
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 338 of file PutPermissionRequest.h.

◆ SetCondition() [2/2]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetCondition ( Condition &&  value)
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 352 of file PutPermissionRequest.h.

◆ SetEventBusName() [1/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetEventBusName ( const Aws::String value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 54 of file PutPermissionRequest.h.

◆ SetEventBusName() [2/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetEventBusName ( Aws::String &&  value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 60 of file PutPermissionRequest.h.

◆ SetEventBusName() [3/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetEventBusName ( const char *  value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 66 of file PutPermissionRequest.h.

◆ SetPrincipal() [1/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetPrincipal ( const Aws::String value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 170 of file PutPermissionRequest.h.

◆ SetPrincipal() [2/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetPrincipal ( Aws::String &&  value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 182 of file PutPermissionRequest.h.

◆ SetPrincipal() [3/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetPrincipal ( const char *  value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 194 of file PutPermissionRequest.h.

◆ SetStatementId() [1/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetStatementId ( const Aws::String value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 255 of file PutPermissionRequest.h.

◆ SetStatementId() [2/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetStatementId ( Aws::String &&  value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 263 of file PutPermissionRequest.h.

◆ SetStatementId() [3/3]

void Aws::CloudWatchEvents::Model::PutPermissionRequest::SetStatementId ( const char *  value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 271 of file PutPermissionRequest.h.

◆ StatementIdHasBeenSet()

bool Aws::CloudWatchEvents::Model::PutPermissionRequest::StatementIdHasBeenSet ( ) const
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 247 of file PutPermissionRequest.h.

◆ WithAction() [1/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithAction ( const Aws::String value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 121 of file PutPermissionRequest.h.

◆ WithAction() [2/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithAction ( Aws::String &&  value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 127 of file PutPermissionRequest.h.

◆ WithAction() [3/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithAction ( const char *  value)
inline

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

Definition at line 133 of file PutPermissionRequest.h.

◆ WithCondition() [1/2]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithCondition ( const Condition value)
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 366 of file PutPermissionRequest.h.

◆ WithCondition() [2/2]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithCondition ( Condition &&  value)
inline

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Definition at line 380 of file PutPermissionRequest.h.

◆ WithEventBusName() [1/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithEventBusName ( const Aws::String value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 72 of file PutPermissionRequest.h.

◆ WithEventBusName() [2/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithEventBusName ( Aws::String &&  value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 78 of file PutPermissionRequest.h.

◆ WithEventBusName() [3/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithEventBusName ( const char *  value)
inline

The event bus associated with the rule. If you omit this, the default event bus is used.

Definition at line 84 of file PutPermissionRequest.h.

◆ WithPrincipal() [1/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithPrincipal ( const Aws::String value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 206 of file PutPermissionRequest.h.

◆ WithPrincipal() [2/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithPrincipal ( Aws::String &&  value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 218 of file PutPermissionRequest.h.

◆ WithPrincipal() [3/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithPrincipal ( const char *  value)
inline

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Definition at line 230 of file PutPermissionRequest.h.

◆ WithStatementId() [1/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithStatementId ( const Aws::String value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 279 of file PutPermissionRequest.h.

◆ WithStatementId() [2/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithStatementId ( Aws::String &&  value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 287 of file PutPermissionRequest.h.

◆ WithStatementId() [3/3]

PutPermissionRequest& Aws::CloudWatchEvents::Model::PutPermissionRequest::WithStatementId ( const char *  value)
inline

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Definition at line 295 of file PutPermissionRequest.h.


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