Class: Aws::ElasticLoadBalancingV2::Types::Action

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Information about an action.

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

Optionally, a rule for an HTTPS listener can also include one of the following user authentication actions: ‘authenticate-oidc`, `authenticate-cognito`, or `jwt-validation`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authenticate_cognito_config ⇒ Types::AuthenticateCognitoActionConfig

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#authenticate_oidc_config ⇒ Types::AuthenticateOidcActionConfig

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#fixed_response_config ⇒ Types::FixedResponseActionConfig

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#forward_config ⇒ Types::ForwardActionConfig

Information for creating an action that distributes requests among multiple target groups. 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`.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#jwt_validation_config ⇒ Types::JwtValidationActionConfig

[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when ‘Type` is `jwt-validation`.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#order ⇒ Integer

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.

Returns:

  • (Integer) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_config ⇒ Types::RedirectActionConfig

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_arn ⇒ String

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 multiple target groups, you must use `ForwardConfig` instead.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of action.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 85

class Action < Struct.new(
  :type,
  :target_group_arn,
  :authenticate_oidc_config,
  :authenticate_cognito_config,
  :order,
  :redirect_config,
  :fixed_response_config,
  :forward_config,
  :jwt_validation_config)
  SENSITIVE = []
  include Aws::Structure
end