AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticLoadBalancingv2::Model::Action Class Reference

#include <Action.h>

Public Member Functions

 Action ()
 
 Action (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Actionoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const ActionTypeEnumGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ActionTypeEnum &value)
 
void SetType (ActionTypeEnum &&value)
 
ActionWithType (const ActionTypeEnum &value)
 
ActionWithType (ActionTypeEnum &&value)
 
const Aws::StringGetTargetGroupArn () const
 
bool TargetGroupArnHasBeenSet () const
 
void SetTargetGroupArn (const Aws::String &value)
 
void SetTargetGroupArn (Aws::String &&value)
 
void SetTargetGroupArn (const char *value)
 
ActionWithTargetGroupArn (const Aws::String &value)
 
ActionWithTargetGroupArn (Aws::String &&value)
 
ActionWithTargetGroupArn (const char *value)
 
const AuthenticateOidcActionConfigGetAuthenticateOidcConfig () const
 
bool AuthenticateOidcConfigHasBeenSet () const
 
void SetAuthenticateOidcConfig (const AuthenticateOidcActionConfig &value)
 
void SetAuthenticateOidcConfig (AuthenticateOidcActionConfig &&value)
 
ActionWithAuthenticateOidcConfig (const AuthenticateOidcActionConfig &value)
 
ActionWithAuthenticateOidcConfig (AuthenticateOidcActionConfig &&value)
 
const AuthenticateCognitoActionConfigGetAuthenticateCognitoConfig () const
 
bool AuthenticateCognitoConfigHasBeenSet () const
 
void SetAuthenticateCognitoConfig (const AuthenticateCognitoActionConfig &value)
 
void SetAuthenticateCognitoConfig (AuthenticateCognitoActionConfig &&value)
 
ActionWithAuthenticateCognitoConfig (const AuthenticateCognitoActionConfig &value)
 
ActionWithAuthenticateCognitoConfig (AuthenticateCognitoActionConfig &&value)
 
int GetOrder () const
 
bool OrderHasBeenSet () const
 
void SetOrder (int value)
 
ActionWithOrder (int value)
 
const RedirectActionConfigGetRedirectConfig () const
 
bool RedirectConfigHasBeenSet () const
 
void SetRedirectConfig (const RedirectActionConfig &value)
 
void SetRedirectConfig (RedirectActionConfig &&value)
 
ActionWithRedirectConfig (const RedirectActionConfig &value)
 
ActionWithRedirectConfig (RedirectActionConfig &&value)
 
const FixedResponseActionConfigGetFixedResponseConfig () const
 
bool FixedResponseConfigHasBeenSet () const
 
void SetFixedResponseConfig (const FixedResponseActionConfig &value)
 
void SetFixedResponseConfig (FixedResponseActionConfig &&value)
 
ActionWithFixedResponseConfig (const FixedResponseActionConfig &value)
 
ActionWithFixedResponseConfig (FixedResponseActionConfig &&value)
 
const ForwardActionConfigGetForwardConfig () const
 
bool ForwardConfigHasBeenSet () const
 
void SetForwardConfig (const ForwardActionConfig &value)
 
void SetForwardConfig (ForwardActionConfig &&value)
 
ActionWithForwardConfig (const ForwardActionConfig &value)
 
ActionWithForwardConfig (ForwardActionConfig &&value)
 

Detailed Description

Information about an action.

Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed.

See Also:

AWS API Reference

Definition at line 40 of file Action.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Aws::ElasticLoadBalancingv2::Model::Action::Action ( )

◆ Action() [2/2]

Aws::ElasticLoadBalancingv2::Model::Action::Action ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AuthenticateCognitoConfigHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::AuthenticateCognitoConfigHasBeenSet ( ) const
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 200 of file Action.h.

◆ AuthenticateOidcConfigHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::AuthenticateOidcConfigHasBeenSet ( ) const
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 159 of file Action.h.

◆ FixedResponseConfigHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::FixedResponseConfigHasBeenSet ( ) const
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 301 of file Action.h.

◆ ForwardConfigHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::ForwardConfigHasBeenSet ( ) const
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 350 of file Action.h.

◆ GetAuthenticateCognitoConfig()

const AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::Action::GetAuthenticateCognitoConfig ( ) const
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 194 of file Action.h.

◆ GetAuthenticateOidcConfig()

const AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::Action::GetAuthenticateOidcConfig ( ) const
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 152 of file Action.h.

◆ GetFixedResponseConfig()

const FixedResponseActionConfig& Aws::ElasticLoadBalancingv2::Model::Action::GetFixedResponseConfig ( ) const
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 294 of file Action.h.

◆ GetForwardConfig()

const ForwardActionConfig& Aws::ElasticLoadBalancingv2::Model::Action::GetForwardConfig ( ) const
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 340 of file Action.h.

◆ GetOrder()

int Aws::ElasticLoadBalancingv2::Model::Action::GetOrder ( ) const
inline

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

Definition at line 231 of file Action.h.

◆ GetRedirectConfig()

const RedirectActionConfig& Aws::ElasticLoadBalancingv2::Model::Action::GetRedirectConfig ( ) const
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 256 of file Action.h.

◆ GetTargetGroupArn()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::Action::GetTargetGroupArn ( ) const
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 88 of file Action.h.

◆ GetType()

const ActionTypeEnum& Aws::ElasticLoadBalancingv2::Model::Action::GetType ( ) const
inline

The type of action.

Definition at line 54 of file Action.h.

◆ operator=()

Action& Aws::ElasticLoadBalancingv2::Model::Action::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OrderHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::OrderHasBeenSet ( ) const
inline

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

Definition at line 237 of file Action.h.

◆ OutputToStream() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ RedirectConfigHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::RedirectConfigHasBeenSet ( ) const
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 262 of file Action.h.

◆ SetAuthenticateCognitoConfig() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetAuthenticateCognitoConfig ( const AuthenticateCognitoActionConfig value)
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 206 of file Action.h.

◆ SetAuthenticateCognitoConfig() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetAuthenticateCognitoConfig ( AuthenticateCognitoActionConfig &&  value)
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 212 of file Action.h.

◆ SetAuthenticateOidcConfig() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetAuthenticateOidcConfig ( const AuthenticateOidcActionConfig value)
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 166 of file Action.h.

◆ SetAuthenticateOidcConfig() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetAuthenticateOidcConfig ( AuthenticateOidcActionConfig &&  value)
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 173 of file Action.h.

◆ SetFixedResponseConfig() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetFixedResponseConfig ( const FixedResponseActionConfig value)
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 308 of file Action.h.

◆ SetFixedResponseConfig() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetFixedResponseConfig ( FixedResponseActionConfig &&  value)
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 315 of file Action.h.

◆ SetForwardConfig() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetForwardConfig ( const ForwardActionConfig value)
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 360 of file Action.h.

◆ SetForwardConfig() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetForwardConfig ( ForwardActionConfig &&  value)
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 370 of file Action.h.

◆ SetOrder()

void Aws::ElasticLoadBalancingv2::Model::Action::SetOrder ( int  value)
inline

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

Definition at line 243 of file Action.h.

◆ SetRedirectConfig() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetRedirectConfig ( const RedirectActionConfig value)
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 268 of file Action.h.

◆ SetRedirectConfig() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetRedirectConfig ( RedirectActionConfig &&  value)
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 274 of file Action.h.

◆ SetTargetGroupArn() [1/3]

void Aws::ElasticLoadBalancingv2::Model::Action::SetTargetGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 104 of file Action.h.

◆ SetTargetGroupArn() [2/3]

void Aws::ElasticLoadBalancingv2::Model::Action::SetTargetGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 112 of file Action.h.

◆ SetTargetGroupArn() [3/3]

void Aws::ElasticLoadBalancingv2::Model::Action::SetTargetGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 120 of file Action.h.

◆ SetType() [1/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetType ( const ActionTypeEnum value)
inline

The type of action.

Definition at line 64 of file Action.h.

◆ SetType() [2/2]

void Aws::ElasticLoadBalancingv2::Model::Action::SetType ( ActionTypeEnum &&  value)
inline

The type of action.

Definition at line 69 of file Action.h.

◆ TargetGroupArnHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::TargetGroupArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 96 of file Action.h.

◆ TypeHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::Action::TypeHasBeenSet ( ) const
inline

The type of action.

Definition at line 59 of file Action.h.

◆ WithAuthenticateCognitoConfig() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithAuthenticateCognitoConfig ( const AuthenticateCognitoActionConfig value)
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 218 of file Action.h.

◆ WithAuthenticateCognitoConfig() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithAuthenticateCognitoConfig ( AuthenticateCognitoActionConfig &&  value)
inline

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Definition at line 224 of file Action.h.

◆ WithAuthenticateOidcConfig() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithAuthenticateOidcConfig ( const AuthenticateOidcActionConfig value)
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 180 of file Action.h.

◆ WithAuthenticateOidcConfig() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithAuthenticateOidcConfig ( AuthenticateOidcActionConfig &&  value)
inline

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Definition at line 187 of file Action.h.

◆ WithFixedResponseConfig() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithFixedResponseConfig ( const FixedResponseActionConfig value)
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 322 of file Action.h.

◆ WithFixedResponseConfig() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithFixedResponseConfig ( FixedResponseActionConfig &&  value)
inline

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Definition at line 329 of file Action.h.

◆ WithForwardConfig() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithForwardConfig ( const ForwardActionConfig value)
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 380 of file Action.h.

◆ WithForwardConfig() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithForwardConfig ( ForwardActionConfig &&  value)
inline

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Definition at line 390 of file Action.h.

◆ WithOrder()

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithOrder ( int  value)
inline

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

Definition at line 249 of file Action.h.

◆ WithRedirectConfig() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithRedirectConfig ( const RedirectActionConfig value)
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 280 of file Action.h.

◆ WithRedirectConfig() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithRedirectConfig ( RedirectActionConfig &&  value)
inline

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Definition at line 286 of file Action.h.

◆ WithTargetGroupArn() [1/3]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithTargetGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 128 of file Action.h.

◆ WithTargetGroupArn() [2/3]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithTargetGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 136 of file Action.h.

◆ WithTargetGroupArn() [3/3]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithTargetGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Definition at line 144 of file Action.h.

◆ WithType() [1/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithType ( const ActionTypeEnum value)
inline

The type of action.

Definition at line 74 of file Action.h.

◆ WithType() [2/2]

Action& Aws::ElasticLoadBalancingv2::Model::Action::WithType ( ActionTypeEnum &&  value)
inline

The type of action.

Definition at line 79 of file Action.h.


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