class Aws::ElasticLoadBalancingV2::Types::CreateRuleInput
@note When making an API call, you may pass CreateRuleInput
data as a hash: { listener_arn: "ListenerArn", # required conditions: [ # required { 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"], }, }, ], priority: 1, # required actions: [ # required { 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, }, }, }, ], tags: [ { key: "TagKey", # required value: "TagValue", }, ], }
@!attribute [rw] listener_arn
The Amazon Resource Name (ARN) of the listener. @return [String]
@!attribute [rw] conditions
The conditions. @return [Array<Types::RuleCondition>]
@!attribute [rw] priority
The rule priority. A listener can't have multiple rules with the same priority. @return [Integer]
@!attribute [rw] actions
The actions. @return [Array<Types::Action>]
@!attribute [rw] tags
The tags to assign to the rule. @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateRuleInput AWS API Documentation
Constants
- SENSITIVE