Skip to content

Type definitions#

Index > ElasticLoadBalancingv2 > Type definitions

Auto-generated documentation for ElasticLoadBalancingv2 type annotations stubs module mypy-boto3-elbv2.

AuthenticateCognitoActionConfigPaginatorTypeDef#

# AuthenticateCognitoActionConfigPaginatorTypeDef definition

class AuthenticateCognitoActionConfigPaginatorTypeDef(TypedDict):
    UserPoolArn: str,
    UserPoolClientId: str,
    UserPoolDomain: str,
    SessionCookieName: NotRequired[str],
    Scope: NotRequired[str],
    SessionTimeout: NotRequired[int],
    AuthenticationRequestExtraParams: NotRequired[Dict[str, str]],
    OnUnauthenticatedRequest: NotRequired[AuthenticateCognitoActionConditionalBehaviorEnumType],  # (1)
  1. See AuthenticateCognitoActionConditionalBehaviorEnumType

AuthenticateOidcActionConfigPaginatorTypeDef#

# AuthenticateOidcActionConfigPaginatorTypeDef definition

class AuthenticateOidcActionConfigPaginatorTypeDef(TypedDict):
    Issuer: str,
    AuthorizationEndpoint: str,
    TokenEndpoint: str,
    UserInfoEndpoint: str,
    ClientId: str,
    ClientSecret: NotRequired[str],
    SessionCookieName: NotRequired[str],
    Scope: NotRequired[str],
    SessionTimeout: NotRequired[int],
    AuthenticationRequestExtraParams: NotRequired[Dict[str, str]],
    OnUnauthenticatedRequest: NotRequired[AuthenticateOidcActionConditionalBehaviorEnumType],  # (1)
    UseExistingClientSecret: NotRequired[bool],
  1. See AuthenticateOidcActionConditionalBehaviorEnumType

FixedResponseActionConfigTypeDef#

# FixedResponseActionConfigTypeDef definition

class FixedResponseActionConfigTypeDef(TypedDict):
    StatusCode: str,
    MessageBody: NotRequired[str],
    ContentType: NotRequired[str],

RedirectActionConfigTypeDef#

# RedirectActionConfigTypeDef definition

class RedirectActionConfigTypeDef(TypedDict):
    StatusCode: RedirectActionStatusCodeEnumType,  # (1)
    Protocol: NotRequired[str],
    Port: NotRequired[str],
    Host: NotRequired[str],
    Path: NotRequired[str],
    Query: NotRequired[str],
  1. See RedirectActionStatusCodeEnumType

AuthenticateCognitoActionConfigTypeDef#

# AuthenticateCognitoActionConfigTypeDef definition

class AuthenticateCognitoActionConfigTypeDef(TypedDict):
    UserPoolArn: str,
    UserPoolClientId: str,
    UserPoolDomain: str,
    SessionCookieName: NotRequired[str],
    Scope: NotRequired[str],
    SessionTimeout: NotRequired[int],
    AuthenticationRequestExtraParams: NotRequired[Mapping[str, str]],
    OnUnauthenticatedRequest: NotRequired[AuthenticateCognitoActionConditionalBehaviorEnumType],  # (1)
  1. See AuthenticateCognitoActionConditionalBehaviorEnumType

AuthenticateOidcActionConfigTypeDef#

# AuthenticateOidcActionConfigTypeDef definition

class AuthenticateOidcActionConfigTypeDef(TypedDict):
    Issuer: str,
    AuthorizationEndpoint: str,
    TokenEndpoint: str,
    UserInfoEndpoint: str,
    ClientId: str,
    ClientSecret: NotRequired[str],
    SessionCookieName: NotRequired[str],
    Scope: NotRequired[str],
    SessionTimeout: NotRequired[int],
    AuthenticationRequestExtraParams: NotRequired[Mapping[str, str]],
    OnUnauthenticatedRequest: NotRequired[AuthenticateOidcActionConditionalBehaviorEnumType],  # (1)
    UseExistingClientSecret: NotRequired[bool],
  1. See AuthenticateOidcActionConditionalBehaviorEnumType

CertificateTypeDef#

# CertificateTypeDef definition

class CertificateTypeDef(TypedDict):
    CertificateArn: NotRequired[str],
    IsDefault: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

RevocationContentTypeDef#

# RevocationContentTypeDef definition

class RevocationContentTypeDef(TypedDict):
    S3Bucket: NotRequired[str],
    S3Key: NotRequired[str],
    S3ObjectVersion: NotRequired[str],
    RevocationType: NotRequired[RevocationTypeType],  # (1)
  1. See RevocationTypeType

TrustStoreRevocationTypeDef#

# TrustStoreRevocationTypeDef definition

class TrustStoreRevocationTypeDef(TypedDict):
    TrustStoreArn: NotRequired[str],
    RevocationId: NotRequired[int],
    RevocationType: NotRequired[RevocationTypeType],  # (1)
    NumberOfRevokedEntries: NotRequired[int],
  1. See RevocationTypeType

AnomalyDetectionTypeDef#

# AnomalyDetectionTypeDef definition

class AnomalyDetectionTypeDef(TypedDict):
    Result: NotRequired[AnomalyResultEnumType],  # (1)
    MitigationInEffect: NotRequired[MitigationInEffectEnumType],  # (2)
  1. See AnomalyResultEnumType
  2. See MitigationInEffectEnumType

LoadBalancerAddressTypeDef#

# LoadBalancerAddressTypeDef definition

class LoadBalancerAddressTypeDef(TypedDict):
    IpAddress: NotRequired[str],
    AllocationId: NotRequired[str],
    PrivateIPv4Address: NotRequired[str],
    IPv6Address: NotRequired[str],

CipherTypeDef#

# CipherTypeDef definition

class CipherTypeDef(TypedDict):
    Name: NotRequired[str],
    Priority: NotRequired[int],

MutualAuthenticationAttributesTypeDef#

# MutualAuthenticationAttributesTypeDef definition

class MutualAuthenticationAttributesTypeDef(TypedDict):
    Mode: NotRequired[str],
    TrustStoreArn: NotRequired[str],
    IgnoreClientCertificateExpiry: NotRequired[bool],

SubnetMappingTypeDef#

# SubnetMappingTypeDef definition

class SubnetMappingTypeDef(TypedDict):
    SubnetId: NotRequired[str],
    AllocationId: NotRequired[str],
    PrivateIPv4Address: NotRequired[str],
    IPv6Address: NotRequired[str],

MatcherTypeDef#

# MatcherTypeDef definition

class MatcherTypeDef(TypedDict):
    HttpCode: NotRequired[str],
    GrpcCode: NotRequired[str],

TrustStoreTypeDef#

# TrustStoreTypeDef definition

class TrustStoreTypeDef(TypedDict):
    Name: NotRequired[str],
    TrustStoreArn: NotRequired[str],
    Status: NotRequired[TrustStoreStatusType],  # (1)
    NumberOfCaCertificates: NotRequired[int],
    TotalRevokedEntries: NotRequired[int],
  1. See TrustStoreStatusType

DeleteListenerInputRequestTypeDef#

# DeleteListenerInputRequestTypeDef definition

class DeleteListenerInputRequestTypeDef(TypedDict):
    ListenerArn: str,

DeleteLoadBalancerInputRequestTypeDef#

# DeleteLoadBalancerInputRequestTypeDef definition

class DeleteLoadBalancerInputRequestTypeDef(TypedDict):
    LoadBalancerArn: str,

DeleteRuleInputRequestTypeDef#

# DeleteRuleInputRequestTypeDef definition

class DeleteRuleInputRequestTypeDef(TypedDict):
    RuleArn: str,

DeleteTargetGroupInputRequestTypeDef#

# DeleteTargetGroupInputRequestTypeDef definition

class DeleteTargetGroupInputRequestTypeDef(TypedDict):
    TargetGroupArn: str,

DeleteTrustStoreInputRequestTypeDef#

# DeleteTrustStoreInputRequestTypeDef definition

class DeleteTrustStoreInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,

TargetDescriptionTypeDef#

# TargetDescriptionTypeDef definition

class TargetDescriptionTypeDef(TypedDict):
    Id: str,
    Port: NotRequired[int],
    AvailabilityZone: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeAccountLimitsInputRequestTypeDef#

# DescribeAccountLimitsInputRequestTypeDef definition

class DescribeAccountLimitsInputRequestTypeDef(TypedDict):
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

LimitTypeDef#

# LimitTypeDef definition

class LimitTypeDef(TypedDict):
    Name: NotRequired[str],
    Max: NotRequired[str],

DescribeListenerCertificatesInputRequestTypeDef#

# DescribeListenerCertificatesInputRequestTypeDef definition

class DescribeListenerCertificatesInputRequestTypeDef(TypedDict):
    ListenerArn: str,
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeListenersInputRequestTypeDef#

# DescribeListenersInputRequestTypeDef definition

class DescribeListenersInputRequestTypeDef(TypedDict):
    LoadBalancerArn: NotRequired[str],
    ListenerArns: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeLoadBalancerAttributesInputRequestTypeDef#

# DescribeLoadBalancerAttributesInputRequestTypeDef definition

class DescribeLoadBalancerAttributesInputRequestTypeDef(TypedDict):
    LoadBalancerArn: str,

LoadBalancerAttributeTypeDef#

# LoadBalancerAttributeTypeDef definition

class LoadBalancerAttributeTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeLoadBalancersInputRequestTypeDef#

# DescribeLoadBalancersInputRequestTypeDef definition

class DescribeLoadBalancersInputRequestTypeDef(TypedDict):
    LoadBalancerArns: NotRequired[Sequence[str]],
    Names: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeRulesInputRequestTypeDef#

# DescribeRulesInputRequestTypeDef definition

class DescribeRulesInputRequestTypeDef(TypedDict):
    ListenerArn: NotRequired[str],
    RuleArns: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeSSLPoliciesInputRequestTypeDef#

# DescribeSSLPoliciesInputRequestTypeDef definition

class DescribeSSLPoliciesInputRequestTypeDef(TypedDict):
    Names: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],
    LoadBalancerType: NotRequired[LoadBalancerTypeEnumType],  # (1)
  1. See LoadBalancerTypeEnumType

DescribeTagsInputRequestTypeDef#

# DescribeTagsInputRequestTypeDef definition

class DescribeTagsInputRequestTypeDef(TypedDict):
    ResourceArns: Sequence[str],

DescribeTargetGroupAttributesInputRequestTypeDef#

# DescribeTargetGroupAttributesInputRequestTypeDef definition

class DescribeTargetGroupAttributesInputRequestTypeDef(TypedDict):
    TargetGroupArn: str,

TargetGroupAttributeTypeDef#

# TargetGroupAttributeTypeDef definition

class TargetGroupAttributeTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

DescribeTargetGroupsInputRequestTypeDef#

# DescribeTargetGroupsInputRequestTypeDef definition

class DescribeTargetGroupsInputRequestTypeDef(TypedDict):
    LoadBalancerArn: NotRequired[str],
    TargetGroupArns: NotRequired[Sequence[str]],
    Names: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeTrustStoreAssociationsInputRequestTypeDef#

# DescribeTrustStoreAssociationsInputRequestTypeDef definition

class DescribeTrustStoreAssociationsInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

TrustStoreAssociationTypeDef#

# TrustStoreAssociationTypeDef definition

class TrustStoreAssociationTypeDef(TypedDict):
    ResourceArn: NotRequired[str],

DescribeTrustStoreRevocationTypeDef#

# DescribeTrustStoreRevocationTypeDef definition

class DescribeTrustStoreRevocationTypeDef(TypedDict):
    TrustStoreArn: NotRequired[str],
    RevocationId: NotRequired[int],
    RevocationType: NotRequired[RevocationTypeType],  # (1)
    NumberOfRevokedEntries: NotRequired[int],
  1. See RevocationTypeType

DescribeTrustStoreRevocationsInputRequestTypeDef#

# DescribeTrustStoreRevocationsInputRequestTypeDef definition

class DescribeTrustStoreRevocationsInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,
    RevocationIds: NotRequired[Sequence[int]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeTrustStoresInputRequestTypeDef#

# DescribeTrustStoresInputRequestTypeDef definition

class DescribeTrustStoresInputRequestTypeDef(TypedDict):
    TrustStoreArns: NotRequired[Sequence[str]],
    Names: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

TargetGroupStickinessConfigTypeDef#

# TargetGroupStickinessConfigTypeDef definition

class TargetGroupStickinessConfigTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    DurationSeconds: NotRequired[int],

TargetGroupTupleTypeDef#

# TargetGroupTupleTypeDef definition

class TargetGroupTupleTypeDef(TypedDict):
    TargetGroupArn: NotRequired[str],
    Weight: NotRequired[int],

GetTrustStoreCaCertificatesBundleInputRequestTypeDef#

# GetTrustStoreCaCertificatesBundleInputRequestTypeDef definition

class GetTrustStoreCaCertificatesBundleInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,

GetTrustStoreRevocationContentInputRequestTypeDef#

# GetTrustStoreRevocationContentInputRequestTypeDef definition

class GetTrustStoreRevocationContentInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,
    RevocationId: int,

HostHeaderConditionConfigPaginatorTypeDef#

# HostHeaderConditionConfigPaginatorTypeDef definition

class HostHeaderConditionConfigPaginatorTypeDef(TypedDict):
    Values: NotRequired[List[str]],

HostHeaderConditionConfigTypeDef#

# HostHeaderConditionConfigTypeDef definition

class HostHeaderConditionConfigTypeDef(TypedDict):
    Values: NotRequired[Sequence[str]],

HttpHeaderConditionConfigPaginatorTypeDef#

# HttpHeaderConditionConfigPaginatorTypeDef definition

class HttpHeaderConditionConfigPaginatorTypeDef(TypedDict):
    HttpHeaderName: NotRequired[str],
    Values: NotRequired[List[str]],

HttpHeaderConditionConfigTypeDef#

# HttpHeaderConditionConfigTypeDef definition

class HttpHeaderConditionConfigTypeDef(TypedDict):
    HttpHeaderName: NotRequired[str],
    Values: NotRequired[Sequence[str]],

HttpRequestMethodConditionConfigPaginatorTypeDef#

# HttpRequestMethodConditionConfigPaginatorTypeDef definition

class HttpRequestMethodConditionConfigPaginatorTypeDef(TypedDict):
    Values: NotRequired[List[str]],

HttpRequestMethodConditionConfigTypeDef#

# HttpRequestMethodConditionConfigTypeDef definition

class HttpRequestMethodConditionConfigTypeDef(TypedDict):
    Values: NotRequired[Sequence[str]],

LoadBalancerStateTypeDef#

# LoadBalancerStateTypeDef definition

class LoadBalancerStateTypeDef(TypedDict):
    Code: NotRequired[LoadBalancerStateEnumType],  # (1)
    Reason: NotRequired[str],
  1. See LoadBalancerStateEnumType

ModifyTrustStoreInputRequestTypeDef#

# ModifyTrustStoreInputRequestTypeDef definition

class ModifyTrustStoreInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,
    CaCertificatesBundleS3Bucket: str,
    CaCertificatesBundleS3Key: str,
    CaCertificatesBundleS3ObjectVersion: NotRequired[str],

PathPatternConditionConfigPaginatorTypeDef#

# PathPatternConditionConfigPaginatorTypeDef definition

class PathPatternConditionConfigPaginatorTypeDef(TypedDict):
    Values: NotRequired[List[str]],

PathPatternConditionConfigTypeDef#

# PathPatternConditionConfigTypeDef definition

class PathPatternConditionConfigTypeDef(TypedDict):
    Values: NotRequired[Sequence[str]],

QueryStringKeyValuePairTypeDef#

# QueryStringKeyValuePairTypeDef definition

class QueryStringKeyValuePairTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

RemoveTagsInputRequestTypeDef#

# RemoveTagsInputRequestTypeDef definition

class RemoveTagsInputRequestTypeDef(TypedDict):
    ResourceArns: Sequence[str],
    TagKeys: Sequence[str],

RemoveTrustStoreRevocationsInputRequestTypeDef#

# RemoveTrustStoreRevocationsInputRequestTypeDef definition

class RemoveTrustStoreRevocationsInputRequestTypeDef(TypedDict):
    TrustStoreArn: str,
    RevocationIds: Sequence[int],

SourceIpConditionConfigPaginatorTypeDef#

# SourceIpConditionConfigPaginatorTypeDef definition

class SourceIpConditionConfigPaginatorTypeDef(TypedDict):
    Values: NotRequired[List[str]],

SourceIpConditionConfigTypeDef#

# SourceIpConditionConfigTypeDef definition

class SourceIpConditionConfigTypeDef(TypedDict):
    Values: NotRequired[Sequence[str]],

RulePriorityPairTypeDef#

# RulePriorityPairTypeDef definition

class RulePriorityPairTypeDef(TypedDict):
    RuleArn: NotRequired[str],
    Priority: NotRequired[int],

SetIpAddressTypeInputRequestTypeDef#

# SetIpAddressTypeInputRequestTypeDef definition

class SetIpAddressTypeInputRequestTypeDef(TypedDict):
    LoadBalancerArn: str,
    IpAddressType: IpAddressTypeType,  # (1)
  1. See IpAddressTypeType

SetSecurityGroupsInputRequestTypeDef#

# SetSecurityGroupsInputRequestTypeDef definition

class SetSecurityGroupsInputRequestTypeDef(TypedDict):
    LoadBalancerArn: str,
    SecurityGroups: Sequence[str],
    EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic: NotRequired[EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnumType],  # (1)
  1. See EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnumType

TargetHealthTypeDef#

# TargetHealthTypeDef definition

class TargetHealthTypeDef(TypedDict):
    State: NotRequired[TargetHealthStateEnumType],  # (1)
    Reason: NotRequired[TargetHealthReasonEnumType],  # (2)
    Description: NotRequired[str],
  1. See TargetHealthStateEnumType
  2. See TargetHealthReasonEnumType

AddListenerCertificatesInputRequestTypeDef#

# AddListenerCertificatesInputRequestTypeDef definition

class AddListenerCertificatesInputRequestTypeDef(TypedDict):
    ListenerArn: str,
    Certificates: Sequence[CertificateTypeDef],  # (1)
  1. See CertificateTypeDef

RemoveListenerCertificatesInputRequestTypeDef#

# RemoveListenerCertificatesInputRequestTypeDef definition

class RemoveListenerCertificatesInputRequestTypeDef(TypedDict):
    ListenerArn: str,
    Certificates: Sequence[CertificateTypeDef],  # (1)
  1. See CertificateTypeDef

AddListenerCertificatesOutputTypeDef#

# AddListenerCertificatesOutputTypeDef definition

class AddListenerCertificatesOutputTypeDef(TypedDict):
    Certificates: List[CertificateTypeDef],