Package-level declarations

Types

Link copied to clipboard
data class GetListenerResult(val alpnPolicy: List<String>? = null, val certificates: List<ListenerCertificate>? = null, val defaultActions: List<ListenerAction>? = null, val listenerArn: String? = null, val listenerAttributes: List<ListenerAttribute>? = null, val mutualAuthentication: ListenerMutualAuthentication? = null, val port: Int? = null, val protocol: String? = null, val sslPolicy: String? = null)
Link copied to clipboard
data class GetListenerRuleResult(val actions: List<ListenerRuleAction>? = null, val conditions: List<ListenerRuleRuleCondition>? = null, val isDefault: Boolean? = null, val priority: Int? = null, val ruleArn: String? = null)
Link copied to clipboard
data class GetLoadBalancerResult(val canonicalHostedZoneId: String? = null, val dnsName: String? = null, val enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: String? = null, val ipAddressType: String? = null, val loadBalancerArn: String? = null, val loadBalancerAttributes: List<LoadBalancerAttribute>? = null, val loadBalancerFullName: String? = null, val loadBalancerName: String? = null, val securityGroups: List<String>? = null, val subnetMappings: List<LoadBalancerSubnetMapping>? = null, val subnets: List<String>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetTargetGroupResult(val healthCheckEnabled: Boolean? = null, val healthCheckIntervalSeconds: Int? = null, val healthCheckPath: String? = null, val healthCheckPort: String? = null, val healthCheckProtocol: String? = null, val healthCheckTimeoutSeconds: Int? = null, val healthyThresholdCount: Int? = null, val loadBalancerArns: List<String>? = null, val matcher: TargetGroupMatcher? = null, val tags: List<Tag>? = null, val targetGroupArn: String? = null, val targetGroupAttributes: List<TargetGroupAttribute>? = null, val targetGroupFullName: String? = null, val targetGroupName: String? = null, val targets: List<TargetGroupTargetDescription>? = null, val unhealthyThresholdCount: Int? = null)
Link copied to clipboard
data class GetTrustStoreResult(val numberOfCaCertificates: Int? = null, val status: String? = null, val tags: List<Tag>? = null, val trustStoreArn: String? = null)
Link copied to clipboard
data class GetTrustStoreRevocationResult(val revocationId: Int? = null, val trustStoreRevocations: List<TrustStoreRevocation>? = null)
Link copied to clipboard
data class ListenerAction(val authenticateCognitoConfig: ListenerAuthenticateCognitoConfig? = null, val authenticateOidcConfig: ListenerAuthenticateOidcConfig? = null, val fixedResponseConfig: ListenerFixedResponseConfig? = null, val forwardConfig: ListenerForwardConfig? = null, val order: Int? = null, val redirectConfig: ListenerRedirectConfig? = null, val targetGroupArn: String? = null, val type: String)

Specifies an action for a listener rule.

Link copied to clipboard
data class ListenerAttribute(val key: String? = null, val value: String? = null)
Link copied to clipboard
data class ListenerAuthenticateCognitoConfig(val authenticationRequestExtraParams: Map<String, String>? = null, val onUnauthenticatedRequest: String? = null, val scope: String? = null, val sessionCookieName: String? = null, val sessionTimeout: String? = null, val userPoolArn: String, val userPoolClientId: String, val userPoolDomain: String)

Specifies information required when integrating with Amazon Cognito to authenticate users.

Link copied to clipboard
data class ListenerAuthenticateOidcConfig(val authenticationRequestExtraParams: Map<String, String>? = null, val authorizationEndpoint: String, val clientId: String, val clientSecret: String? = null, val issuer: String, val onUnauthenticatedRequest: String? = null, val scope: String? = null, val sessionCookieName: String? = null, val sessionTimeout: String? = null, val tokenEndpoint: String, val useExistingClientSecret: Boolean? = null, val userInfoEndpoint: String)

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

Link copied to clipboard
data class ListenerCertificate(val certificateArn: String? = null)

Specifies an SSL server certificate to use as the default certificate for a secure listener.

Link copied to clipboard
data class ListenerFixedResponseConfig(val contentType: String? = null, val messageBody: String? = null, val statusCode: String)

Specifies information required when returning a custom HTTP response.

Link copied to clipboard
data class ListenerForwardConfig(val targetGroupStickinessConfig: ListenerTargetGroupStickinessConfig? = null, val targetGroups: List<ListenerTargetGroupTuple>? = null)

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. 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`.

Link copied to clipboard
data class ListenerMutualAuthentication(val ignoreClientCertificateExpiry: Boolean? = null, val mode: String? = null, val trustStoreArn: String? = null)

Specifies the configuration information for mutual authentication.

Link copied to clipboard
data class ListenerRedirectConfig(val host: String? = null, val path: String? = null, val port: String? = null, val protocol: String? = null, val query: String? = null, val statusCode: String)

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:

Link copied to clipboard
data class ListenerRuleAction(val authenticateCognitoConfig: ListenerRuleAuthenticateCognitoConfig? = null, val authenticateOidcConfig: ListenerRuleAuthenticateOidcConfig? = null, val fixedResponseConfig: ListenerRuleFixedResponseConfig? = null, val forwardConfig: ListenerRuleForwardConfig? = null, val order: Int? = null, val redirectConfig: ListenerRuleRedirectConfig? = null, val targetGroupArn: String? = null, val type: String)

Specifies an action for a listener rule.

Link copied to clipboard
data class ListenerRuleAuthenticateCognitoConfig(val authenticationRequestExtraParams: Map<String, String>? = null, val onUnauthenticatedRequest: String? = null, val scope: String? = null, val sessionCookieName: String? = null, val sessionTimeout: Int? = null, val userPoolArn: String, val userPoolClientId: String, val userPoolDomain: String)

Specifies information required when integrating with Amazon Cognito to authenticate users.

Link copied to clipboard
data class ListenerRuleAuthenticateOidcConfig(val authenticationRequestExtraParams: Map<String, String>? = null, val authorizationEndpoint: String, val clientId: String, val clientSecret: String? = null, val issuer: String, val onUnauthenticatedRequest: String? = null, val scope: String? = null, val sessionCookieName: String? = null, val sessionTimeout: Int? = null, val tokenEndpoint: String, val useExistingClientSecret: Boolean? = null, val userInfoEndpoint: String)

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

Link copied to clipboard
data class ListenerRuleFixedResponseConfig(val contentType: String? = null, val messageBody: String? = null, val statusCode: String)

Specifies information required when returning a custom HTTP response.

Link copied to clipboard
data class ListenerRuleForwardConfig(val targetGroupStickinessConfig: ListenerRuleTargetGroupStickinessConfig? = null, val targetGroups: List<ListenerRuleTargetGroupTuple>? = null)

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. 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`.

Link copied to clipboard
data class ListenerRuleHostHeaderConfig(val values: List<String>? = null)

Information about a host header condition.

Link copied to clipboard
data class ListenerRuleHttpHeaderConfig(val httpHeaderName: String? = null, val values: List<String>? = null)

Information about an HTTP header condition. There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

Link copied to clipboard
data class ListenerRuleHttpRequestMethodConfig(val values: List<String>? = null)

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.

Link copied to clipboard
data class ListenerRulePathPatternConfig(val values: List<String>? = null)

Information about a path pattern condition.

Link copied to clipboard

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.

Link copied to clipboard
data class ListenerRuleQueryStringKeyValue(val key: String? = null, val value: String? = null)

Information about a key/value pair.

Link copied to clipboard
data class ListenerRuleRedirectConfig(val host: String? = null, val path: String? = null, val port: String? = null, val protocol: String? = null, val query: String? = null, val statusCode: String)

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:

Link copied to clipboard
data class ListenerRuleRuleCondition(val field: String? = null, val hostHeaderConfig: ListenerRuleHostHeaderConfig? = null, val httpHeaderConfig: ListenerRuleHttpHeaderConfig? = null, val httpRequestMethodConfig: ListenerRuleHttpRequestMethodConfig? = null, val pathPatternConfig: ListenerRulePathPatternConfig? = null, val queryStringConfig: ListenerRuleQueryStringConfig? = null, val sourceIpConfig: ListenerRuleSourceIpConfig? = null, val values: List<String>? = null)

Specifies a condition for a listener rule.

Link copied to clipboard
data class ListenerRuleSourceIpConfig(val values: List<String>? = null)

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.

Link copied to clipboard
data class ListenerRuleTargetGroupStickinessConfig(val durationSeconds: Int? = null, val enabled: Boolean? = null)

Information about the target group stickiness for a rule.

Link copied to clipboard
data class ListenerRuleTargetGroupTuple(val targetGroupArn: String? = null, val weight: Int? = null)

Information about how traffic will be distributed between multiple target groups in a forward rule.

Link copied to clipboard
data class ListenerTargetGroupStickinessConfig(val durationSeconds: Int? = null, val enabled: Boolean? = null)

Information about the target group stickiness for a rule.

Link copied to clipboard
data class ListenerTargetGroupTuple(val targetGroupArn: String? = null, val weight: Int? = null)

Information about how traffic will be distributed between multiple target groups in a forward rule.

Link copied to clipboard
data class LoadBalancerAttribute(val key: String? = null, val value: String? = null)

Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

Link copied to clipboard
data class LoadBalancerSubnetMapping(val allocationId: String? = null, val iPv6Address: String? = null, val privateIPv4Address: String? = null, val subnetId: String)

Specifies a subnet for a load balancer.

Link copied to clipboard
data class TargetGroupAttribute(val key: String? = null, val value: String? = null)
Link copied to clipboard
data class TargetGroupMatcher(val grpcCode: String? = null, val httpCode: String? = null)
Link copied to clipboard
data class TargetGroupTargetDescription(val availabilityZone: String? = null, val id: String, val port: Int? = null)
Link copied to clipboard
data class TrustStoreRevocation(val numberOfRevokedEntries: Int? = null, val revocationId: String? = null, val revocationType: String? = null, val trustStoreArn: String? = null)
Link copied to clipboard
data class TrustStoreRevocationRevocationContent(val revocationType: String? = null, val s3Bucket: String? = null, val s3Key: String? = null, val s3ObjectVersion: String? = null)