AWS SDK for C++  1.9.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodePipeline::Model::WebhookDefinition Class Reference

#include <WebhookDefinition.h>

Public Member Functions

 WebhookDefinition ()
 
 WebhookDefinition (Aws::Utils::Json::JsonView jsonValue)
 
WebhookDefinitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
WebhookDefinitionWithName (const Aws::String &value)
 
WebhookDefinitionWithName (Aws::String &&value)
 
WebhookDefinitionWithName (const char *value)
 
const Aws::StringGetTargetPipeline () const
 
bool TargetPipelineHasBeenSet () const
 
void SetTargetPipeline (const Aws::String &value)
 
void SetTargetPipeline (Aws::String &&value)
 
void SetTargetPipeline (const char *value)
 
WebhookDefinitionWithTargetPipeline (const Aws::String &value)
 
WebhookDefinitionWithTargetPipeline (Aws::String &&value)
 
WebhookDefinitionWithTargetPipeline (const char *value)
 
const Aws::StringGetTargetAction () const
 
bool TargetActionHasBeenSet () const
 
void SetTargetAction (const Aws::String &value)
 
void SetTargetAction (Aws::String &&value)
 
void SetTargetAction (const char *value)
 
WebhookDefinitionWithTargetAction (const Aws::String &value)
 
WebhookDefinitionWithTargetAction (Aws::String &&value)
 
WebhookDefinitionWithTargetAction (const char *value)
 
const Aws::Vector< WebhookFilterRule > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< WebhookFilterRule > &value)
 
void SetFilters (Aws::Vector< WebhookFilterRule > &&value)
 
WebhookDefinitionWithFilters (const Aws::Vector< WebhookFilterRule > &value)
 
WebhookDefinitionWithFilters (Aws::Vector< WebhookFilterRule > &&value)
 
WebhookDefinitionAddFilters (const WebhookFilterRule &value)
 
WebhookDefinitionAddFilters (WebhookFilterRule &&value)
 
const WebhookAuthenticationTypeGetAuthentication () const
 
bool AuthenticationHasBeenSet () const
 
void SetAuthentication (const WebhookAuthenticationType &value)
 
void SetAuthentication (WebhookAuthenticationType &&value)
 
WebhookDefinitionWithAuthentication (const WebhookAuthenticationType &value)
 
WebhookDefinitionWithAuthentication (WebhookAuthenticationType &&value)
 
const WebhookAuthConfigurationGetAuthenticationConfiguration () const
 
bool AuthenticationConfigurationHasBeenSet () const
 
void SetAuthenticationConfiguration (const WebhookAuthConfiguration &value)
 
void SetAuthenticationConfiguration (WebhookAuthConfiguration &&value)
 
WebhookDefinitionWithAuthenticationConfiguration (const WebhookAuthConfiguration &value)
 
WebhookDefinitionWithAuthenticationConfiguration (WebhookAuthConfiguration &&value)
 

Detailed Description

Represents information about a webhook and its definition.

See Also:

AWS API Reference

Definition at line 36 of file WebhookDefinition.h.

Constructor & Destructor Documentation

◆ WebhookDefinition() [1/2]

Aws::CodePipeline::Model::WebhookDefinition::WebhookDefinition ( )

◆ WebhookDefinition() [2/2]

Aws::CodePipeline::Model::WebhookDefinition::WebhookDefinition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddFilters() [1/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::AddFilters ( const WebhookFilterRule value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 223 of file WebhookDefinition.h.

◆ AddFilters() [2/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::AddFilters ( WebhookFilterRule &&  value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 230 of file WebhookDefinition.h.

◆ AuthenticationConfigurationHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::AuthenticationConfigurationHasBeenSet ( ) const
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 322 of file WebhookDefinition.h.

◆ AuthenticationHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::AuthenticationHasBeenSet ( ) const
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 255 of file WebhookDefinition.h.

◆ FiltersHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::FiltersHasBeenSet ( ) const
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 188 of file WebhookDefinition.h.

◆ GetAuthentication()

const WebhookAuthenticationType& Aws::CodePipeline::Model::WebhookDefinition::GetAuthentication ( ) const
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 243 of file WebhookDefinition.h.

◆ GetAuthenticationConfiguration()

const WebhookAuthConfiguration& Aws::CodePipeline::Model::WebhookDefinition::GetAuthenticationConfiguration ( ) const
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 313 of file WebhookDefinition.h.

◆ GetFilters()

const Aws::Vector<WebhookFilterRule>& Aws::CodePipeline::Model::WebhookDefinition::GetFilters ( ) const
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 181 of file WebhookDefinition.h.

◆ GetName()

const Aws::String& Aws::CodePipeline::Model::WebhookDefinition::GetName ( ) const
inline

The name of the webhook.

Definition at line 48 of file WebhookDefinition.h.

◆ GetTargetAction()

const Aws::String& Aws::CodePipeline::Model::WebhookDefinition::GetTargetAction ( ) const
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 131 of file WebhookDefinition.h.

◆ GetTargetPipeline()

const Aws::String& Aws::CodePipeline::Model::WebhookDefinition::GetTargetPipeline ( ) const
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 89 of file WebhookDefinition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodePipeline::Model::WebhookDefinition::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::NameHasBeenSet ( ) const
inline

The name of the webhook.

Definition at line 53 of file WebhookDefinition.h.

◆ operator=()

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAuthentication() [1/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetAuthentication ( const WebhookAuthenticationType value)
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 267 of file WebhookDefinition.h.

◆ SetAuthentication() [2/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetAuthentication ( WebhookAuthenticationType &&  value)
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 279 of file WebhookDefinition.h.

◆ SetAuthenticationConfiguration() [1/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetAuthenticationConfiguration ( const WebhookAuthConfiguration value)
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 331 of file WebhookDefinition.h.

◆ SetAuthenticationConfiguration() [2/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetAuthenticationConfiguration ( WebhookAuthConfiguration &&  value)
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 340 of file WebhookDefinition.h.

◆ SetFilters() [1/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetFilters ( Aws::Vector< WebhookFilterRule > &&  value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 202 of file WebhookDefinition.h.

◆ SetFilters() [2/2]

void Aws::CodePipeline::Model::WebhookDefinition::SetFilters ( const Aws::Vector< WebhookFilterRule > &  value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 195 of file WebhookDefinition.h.

◆ SetName() [1/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetName ( Aws::String &&  value)
inline

The name of the webhook.

Definition at line 63 of file WebhookDefinition.h.

◆ SetName() [2/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetName ( const Aws::String value)
inline

The name of the webhook.

Definition at line 58 of file WebhookDefinition.h.

◆ SetName() [3/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetName ( const char *  value)
inline

The name of the webhook.

Definition at line 68 of file WebhookDefinition.h.

◆ SetTargetAction() [1/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetAction ( Aws::String &&  value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 149 of file WebhookDefinition.h.

◆ SetTargetAction() [2/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetAction ( const Aws::String value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 143 of file WebhookDefinition.h.

◆ SetTargetAction() [3/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetAction ( const char *  value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 155 of file WebhookDefinition.h.

◆ SetTargetPipeline() [1/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetPipeline ( Aws::String &&  value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 104 of file WebhookDefinition.h.

◆ SetTargetPipeline() [2/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetPipeline ( const Aws::String value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 99 of file WebhookDefinition.h.

◆ SetTargetPipeline() [3/3]

void Aws::CodePipeline::Model::WebhookDefinition::SetTargetPipeline ( const char *  value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 109 of file WebhookDefinition.h.

◆ TargetActionHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::TargetActionHasBeenSet ( ) const
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 137 of file WebhookDefinition.h.

◆ TargetPipelineHasBeenSet()

bool Aws::CodePipeline::Model::WebhookDefinition::TargetPipelineHasBeenSet ( ) const
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 94 of file WebhookDefinition.h.

◆ WithAuthentication() [1/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithAuthentication ( const WebhookAuthenticationType value)
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 291 of file WebhookDefinition.h.

◆ WithAuthentication() [2/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithAuthentication ( WebhookAuthenticationType &&  value)
inline

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Definition at line 303 of file WebhookDefinition.h.

◆ WithAuthenticationConfiguration() [1/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithAuthenticationConfiguration ( const WebhookAuthConfiguration value)
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 349 of file WebhookDefinition.h.

◆ WithAuthenticationConfiguration() [2/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithAuthenticationConfiguration ( WebhookAuthConfiguration &&  value)
inline

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Definition at line 358 of file WebhookDefinition.h.

◆ WithFilters() [1/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithFilters ( Aws::Vector< WebhookFilterRule > &&  value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 216 of file WebhookDefinition.h.

◆ WithFilters() [2/2]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithFilters ( const Aws::Vector< WebhookFilterRule > &  value)
inline

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Definition at line 209 of file WebhookDefinition.h.

◆ WithName() [1/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithName ( Aws::String &&  value)
inline

The name of the webhook.

Definition at line 78 of file WebhookDefinition.h.

◆ WithName() [2/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithName ( const Aws::String value)
inline

The name of the webhook.

Definition at line 73 of file WebhookDefinition.h.

◆ WithName() [3/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithName ( const char *  value)
inline

The name of the webhook.

Definition at line 83 of file WebhookDefinition.h.

◆ WithTargetAction() [1/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetAction ( Aws::String &&  value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 167 of file WebhookDefinition.h.

◆ WithTargetAction() [2/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetAction ( const Aws::String value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 161 of file WebhookDefinition.h.

◆ WithTargetAction() [3/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetAction ( const char *  value)
inline

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

Definition at line 173 of file WebhookDefinition.h.

◆ WithTargetPipeline() [1/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetPipeline ( Aws::String &&  value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 119 of file WebhookDefinition.h.

◆ WithTargetPipeline() [2/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetPipeline ( const Aws::String value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 114 of file WebhookDefinition.h.

◆ WithTargetPipeline() [3/3]

WebhookDefinition& Aws::CodePipeline::Model::WebhookDefinition::WithTargetPipeline ( const char *  value)
inline

The name of the pipeline you want to connect to the webhook.

Definition at line 124 of file WebhookDefinition.h.


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