Class: Aws::ElasticLoadBalancingV2::Types::ModifyRuleInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticLoadBalancingV2::Types::ModifyRuleInput
- Defined in:
- gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb
Overview
Note:
When making an API call, you may pass ModifyRuleInput data as a hash:
{
rule_arn: "RuleArn", # required
conditions: [
{
field: "ConditionFieldName",
values: ["StringValue"],
host_header_config: {
values: ["StringValue"],
},
path_pattern_config: {
values: ["StringValue"],
},
http_header_config: {
http_header_name: "HttpHeaderConditionName",
values: ["StringValue"],
},
query_string_config: {
values: [
{
key: "StringValue",
value: "StringValue",
},
],
},
http_request_method_config: {
values: ["StringValue"],
},
source_ip_config: {
values: ["StringValue"],
},
},
],
actions: [
{
type: "forward", # required, accepts forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response
target_group_arn: "TargetGroupArn",
authenticate_oidc_config: {
issuer: "AuthenticateOidcActionIssuer", # required
authorization_endpoint: "AuthenticateOidcActionAuthorizationEndpoint", # required
token_endpoint: "AuthenticateOidcActionTokenEndpoint", # required
user_info_endpoint: "AuthenticateOidcActionUserInfoEndpoint", # required
client_id: "AuthenticateOidcActionClientId", # required
client_secret: "AuthenticateOidcActionClientSecret",
session_cookie_name: "AuthenticateOidcActionSessionCookieName",
scope: "AuthenticateOidcActionScope",
session_timeout: 1,
authentication_request_extra_params: {
"AuthenticateOidcActionAuthenticationRequestParamName" => "AuthenticateOidcActionAuthenticationRequestParamValue",
},
on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
use_existing_client_secret: false,
},
authenticate_cognito_config: {
user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
scope: "AuthenticateCognitoActionScope",
session_timeout: 1,
authentication_request_extra_params: {
"AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
},
on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
},
order: 1,
redirect_config: {
protocol: "RedirectActionProtocol",
port: "RedirectActionPort",
host: "RedirectActionHost",
path: "RedirectActionPath",
query: "RedirectActionQuery",
status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
},
fixed_response_config: {
message_body: "FixedResponseActionMessage",
status_code: "FixedResponseActionStatusCode", # required
content_type: "FixedResponseActionContentType",
},
forward_config: {
target_groups: [
{
target_group_arn: "TargetGroupArn",
weight: 1,
},
],
target_group_stickiness_config: {
enabled: false,
duration_seconds: 1,
},
},
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#actions ⇒ Array<Types::Action>
The actions.
-
#conditions ⇒ Array<Types::RuleCondition>
The conditions.
-
#rule_arn ⇒ String
The Amazon Resource Name (ARN) of the rule.
Instance Attribute Details
#actions ⇒ Array<Types::Action>
The actions.
2878 2879 2880 2881 2882 2883 2884 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2878 class ModifyRuleInput < Struct.new( :rule_arn, :conditions, :actions) SENSITIVE = [] include Aws::Structure end |
#conditions ⇒ Array<Types::RuleCondition>
The conditions.
2878 2879 2880 2881 2882 2883 2884 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2878 class ModifyRuleInput < Struct.new( :rule_arn, :conditions, :actions) SENSITIVE = [] include Aws::Structure end |
#rule_arn ⇒ String
The Amazon Resource Name (ARN) of the rule.
2878 2879 2880 2881 2882 2883 2884 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2878 class ModifyRuleInput < Struct.new( :rule_arn, :conditions, :actions) SENSITIVE = [] include Aws::Structure end |