Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Action
Information about an action.
Each rule must include exactly one of the following types of actions:
forward,fixed-response, orredirect, and it must be the last action to be performed.- Administrative
Override Information about the override status applied to a target.
- Anomaly
Detection Information about anomaly detection and mitigation.
- Authenticate
Cognito Action Config Request parameters to use when integrating with Amazon Cognito to authenticate users.
- Authenticate
Oidc Action Config Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
- Availability
Zone Information about an Availability Zone.
- Capacity
Reservation Status The status of a capacity reservation.
- Certificate
Information about an SSL server certificate.
- Cipher
Information about a cipher used in a policy.
- Describe
Trust Store Revocation Information about the revocations used by a trust store.
- Fixed
Response Action Config Information about an action that returns a custom HTTP response.
- Forward
Action Config Information about a forward action.
- Host
Header Condition Config Information about a host header condition.
- Host
Header Rewrite Config Information about a host header rewrite transform. This transform matches a pattern in the host header in an HTTP request and replaces it with the specified string.
- Http
Header Condition Config Information about an HTTP header condition.
There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
- Http
Request Method Condition Config Information about an HTTP method condition.
HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry. You can also define custom HTTP methods.
- Ipam
Pools An IPAM pool is a collection of IP address CIDRs. IPAM pools enable you to organize your IP addresses according to your routing and security needs.
- Limit
Information about an Elastic Load Balancing resource limit for your Amazon Web Services account.
For more information, see the following:
- Listener
Information about a listener.
- Listener
Attribute Information about a listener attribute.
- Load
Balancer Information about a load balancer.
- Load
Balancer Address Information about a static IP address for a load balancer.
- Load
Balancer Attribute Information about a load balancer attribute.
- Load
Balancer State Information about the state of the load balancer.
- Matcher
The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
- Minimum
Load Balancer Capacity The minimum capacity for a load balancer.
- Mutual
Authentication Attributes Information about the mutual authentication attributes of a listener.
- Path
Pattern Condition Config Information about a path pattern condition.
- Query
String Condition Config Information about a query string condition.
The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
- Query
String KeyValue Pair Information about a key/value pair.
- Redirect
Action Config Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
-
#{protocol}
-
#{host}
-
#{port}
-
#{path} (the leading "/" is removed)
-
#{query}
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
-
- Revocation
Content Information about a revocation file.
- Rewrite
Config Information about a rewrite transform. This transform matches a pattern and replaces it with the specified string.
- Rule
Information about a rule.
- Rule
Condition Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions:
http-request-method,host-header,path-pattern, andsource-ip. Each rule can also optionally include one or more of each of the following conditions:http-headerandquery-string. Note that the value for a condition can't be empty.For more information, see Quotas for your Application Load Balancers.
- Rule
Priority Pair Information about the priorities for the rules for a listener.
- Rule
Transform Information about a transform to apply to requests that match a rule. Transforms are applied to requests before they are sent to targets.
- Source
IpCondition Config Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
- SslPolicy
Information about a policy used for SSL negotiation.
- Subnet
Mapping Information about a subnet mapping.
- Tag
Information about a tag.
- TagDescription
The tags associated with a resource.
- Target
Description Information about a target.
- Target
Group Information about a target group.
- Target
Group Attribute Information about a target group attribute.
- Target
Group Stickiness Config Information about the target group stickiness for a rule.
- Target
Group Tuple Information about how traffic will be distributed between multiple target groups in a forward rule.
- Target
Health Information about the current health of a target.
- Target
Health Description Information about the health of a target.
- Trust
Store Information about a trust store.
- Trust
Store Association Information about the resources a trust store is associated with.
- Trust
Store Revocation Information about a revocation file in use by a trust store.
- UrlRewrite
Config Information about a URL rewrite transform. This transform matches a pattern in the request URL and replaces it with the specified string.
- Zonal
Capacity Reservation State The capacity reservation status for each Availability Zone.
Enums§
- Action
Type Enum - When writing a match expression against
ActionTypeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Advertise
Trust Store CaNames Enum - When writing a match expression against
AdvertiseTrustStoreCaNamesEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Anomaly
Result Enum - When writing a match expression against
AnomalyResultEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Authenticate
Cognito Action Conditional Behavior Enum - When writing a match expression against
AuthenticateCognitoActionConditionalBehaviorEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Authenticate
Oidc Action Conditional Behavior Enum - When writing a match expression against
AuthenticateOidcActionConditionalBehaviorEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Capacity
Reservation State Enum - When writing a match expression against
CapacityReservationStateEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Describe
Target Health Input Include Enum - When writing a match expression against
DescribeTargetHealthInputIncludeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Enable
Prefix ForIpv6 Source NatEnum - When writing a match expression against
EnablePrefixForIpv6SourceNatEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Enforce
Security Group Inbound Rules OnPrivate Link Traffic Enum - When writing a match expression against
EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IpAddress
Type - When writing a match expression against
IpAddressType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Load
Balancer Scheme Enum - When writing a match expression against
LoadBalancerSchemeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Load
Balancer State Enum - When writing a match expression against
LoadBalancerStateEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Load
Balancer Type Enum - When writing a match expression against
LoadBalancerTypeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Mitigation
InEffect Enum - When writing a match expression against
MitigationInEffectEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protocol
Enum - When writing a match expression against
ProtocolEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Redirect
Action Status Code Enum - When writing a match expression against
RedirectActionStatusCodeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Remove
Ipam Pool Enum - When writing a match expression against
RemoveIpamPoolEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Revocation
Type - When writing a match expression against
RevocationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Administrative Override Reason Enum - When writing a match expression against
TargetAdministrativeOverrideReasonEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Administrative Override State Enum - When writing a match expression against
TargetAdministrativeOverrideStateEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Group IpAddress Type Enum - When writing a match expression against
TargetGroupIpAddressTypeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Health Reason Enum - When writing a match expression against
TargetHealthReasonEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Health State Enum - When writing a match expression against
TargetHealthStateEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Type Enum - When writing a match expression against
TargetTypeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Transform
Type Enum - When writing a match expression against
TransformTypeEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Trust
Store Association Status Enum - When writing a match expression against
TrustStoreAssociationStatusEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Trust
Store Status - When writing a match expression against
TrustStoreStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.