AlbListenerSchema
Hierarchy
- BaseResourceSchema- AlbListenerSchema
 
Index
Properties
Properties
inheritedparents
properties
Input properties.
- properties.awsAccountId- The AWS account ID.
- properties.awsRegionId- The AWS region ID.
- properties.DefaultActions- Specify an action to run when none of the conditions are met. See IAlbListenerActionTypes for options.
- properties.Port- The port on which the listener is listening.
- properties.Protocol- The protocol to use. Valid values are- HTTP.
- properties.rules- Specify the rules for the listener. A rule must contain conditions as per IAlbListenerRuleTypes, a set of actions to perform if the conditions are met as per IAlbListenerActionTypes, and a priority which determines the order in which the rules are evaluated.
Type declaration
- awsAccountId: string
- awsRegionId: string
- DefaultActions: ({ action: AlbListenerActionFixedResponseActionSchema; actionType: fixed-response } | { action: AlbListenerActionForwardConfigSchema; actionType: forward } | { action: AlbListenerActionRedirectActionSchema; actionType: redirect })[]
- Port: number
- Protocol: HTTP
- rules: { actions: ({ action: AlbListenerActionFixedResponseActionSchema; actionType: fixed-response } | { action: AlbListenerActionForwardConfigSchema; actionType: forward } | { action: AlbListenerActionRedirectActionSchema; actionType: redirect })[]; conditions: ({ condition: AlbListenerRuleHostHeaderConditionSchema; conditionType: host-header } | { condition: AlbListenerRuleHttpHeaderConditionSchema; conditionType: http-header } | { condition: AlbListenerRuleHttpRequestMethodConditionSchema; conditionType: http-request-method } | { condition: AlbListenerRulePathPatternConditionSchema; conditionType: path-pattern } | { condition: AlbListenerRuleQueryStringConditionSchema; conditionType: query-string } | { condition: AlbListenerRuleSourceIpConditionSchema; conditionType: source-ip })[]; Priority: number }[]
inheritedresourceId
response
Saved response.
- response.ListenerArn- ALB Listener ARN.
- response.Rules- An array of ALB Listener Rule ARNs and priorities.
Type declaration
- optionalListenerArn?: string
- optionalRules?: { Priority: number; RuleArn: string }[]
inheritedtags
Type declaration
- [key string]: string
The
AlbListenerSchemaclass is the schema for theAlbListenerresource, which represents the AWS Application Load Balancer Listener resource. This resource can create a alb listener in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.Resources/AlbListener
parents - This resource has parents.
resourceId - The resource id is of format
alb-listener-<alb-name>