Skip to content

Type definitions#

Index > ElasticLoadBalancing > Type definitions

Auto-generated documentation for ElasticLoadBalancing type annotations stubs module mypy-boto3-elb.

LoadBalancerAttributesUnionTypeDef#

# LoadBalancerAttributesUnionTypeDef definition

LoadBalancerAttributesUnionTypeDef = Union[
    LoadBalancerAttributesTypeDef,  # (1)
    LoadBalancerAttributesOutputTypeDef,  # (2)
]
  1. See LoadBalancerAttributesTypeDef
  2. See LoadBalancerAttributesOutputTypeDef

AccessLogTypeDef#

# AccessLogTypeDef definition

class AccessLogTypeDef(TypedDict):
    Enabled: bool,
    S3BucketName: NotRequired[str],
    EmitInterval: NotRequired[int],
    S3BucketPrefix: NotRequired[str],

AddAvailabilityZonesInputRequestTypeDef#

# AddAvailabilityZonesInputRequestTypeDef definition

class AddAvailabilityZonesInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    AvailabilityZones: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

AdditionalAttributeTypeDef#

# AdditionalAttributeTypeDef definition

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

AppCookieStickinessPolicyTypeDef#

# AppCookieStickinessPolicyTypeDef definition

class AppCookieStickinessPolicyTypeDef(TypedDict):
    PolicyName: NotRequired[str],
    CookieName: NotRequired[str],

ApplySecurityGroupsToLoadBalancerInputRequestTypeDef#

# ApplySecurityGroupsToLoadBalancerInputRequestTypeDef definition

class ApplySecurityGroupsToLoadBalancerInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    SecurityGroups: Sequence[str],

AttachLoadBalancerToSubnetsInputRequestTypeDef#

# AttachLoadBalancerToSubnetsInputRequestTypeDef definition

class AttachLoadBalancerToSubnetsInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    Subnets: Sequence[str],

BackendServerDescriptionTypeDef#

# BackendServerDescriptionTypeDef definition

class BackendServerDescriptionTypeDef(TypedDict):
    InstancePort: NotRequired[int],
    PolicyNames: NotRequired[List[str]],

HealthCheckTypeDef#

# HealthCheckTypeDef definition

class HealthCheckTypeDef(TypedDict):
    Target: str,
    Interval: int,
    Timeout: int,
    UnhealthyThreshold: int,
    HealthyThreshold: int,

ConnectionDrainingTypeDef#

# ConnectionDrainingTypeDef definition

class ConnectionDrainingTypeDef(TypedDict):
    Enabled: bool,
    Timeout: NotRequired[int],

ConnectionSettingsTypeDef#

# ConnectionSettingsTypeDef definition

class ConnectionSettingsTypeDef(TypedDict):
    IdleTimeout: int,

ListenerTypeDef#

# ListenerTypeDef definition

class ListenerTypeDef(TypedDict):
    Protocol: str,
    LoadBalancerPort: int,
    InstancePort: int,
    InstanceProtocol: NotRequired[str],
    SSLCertificateId: NotRequired[str],

CreateAppCookieStickinessPolicyInputRequestTypeDef#

# CreateAppCookieStickinessPolicyInputRequestTypeDef definition

class CreateAppCookieStickinessPolicyInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    PolicyName: str,
    CookieName: str,

CreateLBCookieStickinessPolicyInputRequestTypeDef#

# CreateLBCookieStickinessPolicyInputRequestTypeDef definition

class CreateLBCookieStickinessPolicyInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    PolicyName: str,
    CookieExpirationPeriod: NotRequired[int],

PolicyAttributeTypeDef#

# PolicyAttributeTypeDef definition

class PolicyAttributeTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeValue: NotRequired[str],

CrossZoneLoadBalancingTypeDef#

# CrossZoneLoadBalancingTypeDef definition

class CrossZoneLoadBalancingTypeDef(TypedDict):
    Enabled: bool,

DeleteAccessPointInputRequestTypeDef#

# DeleteAccessPointInputRequestTypeDef definition

class DeleteAccessPointInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,

DeleteLoadBalancerListenerInputRequestTypeDef#

# DeleteLoadBalancerListenerInputRequestTypeDef definition

class DeleteLoadBalancerListenerInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    LoadBalancerPorts: Sequence[int],

DeleteLoadBalancerPolicyInputRequestTypeDef#

# DeleteLoadBalancerPolicyInputRequestTypeDef definition

class DeleteLoadBalancerPolicyInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    PolicyName: str,

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    InstanceId: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeAccessPointsInputRequestTypeDef#

# DescribeAccessPointsInputRequestTypeDef definition

class DescribeAccessPointsInputRequestTypeDef(TypedDict):
    LoadBalancerNames: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    PageSize: NotRequired[int],

DescribeAccountLimitsInputRequestTypeDef#

# DescribeAccountLimitsInputRequestTypeDef definition

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

LimitTypeDef#

# LimitTypeDef definition

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

InstanceStateTypeDef#

# InstanceStateTypeDef definition

class InstanceStateTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    State: NotRequired[str],
    ReasonCode: NotRequired[str],
    Description: NotRequired[str],

DescribeLoadBalancerAttributesInputRequestTypeDef#

# DescribeLoadBalancerAttributesInputRequestTypeDef definition

class DescribeLoadBalancerAttributesInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,

DescribeLoadBalancerPoliciesInputRequestTypeDef#

# DescribeLoadBalancerPoliciesInputRequestTypeDef definition

class DescribeLoadBalancerPoliciesInputRequestTypeDef(TypedDict):
    LoadBalancerName: NotRequired[str],
    PolicyNames: NotRequired[Sequence[str]],

DescribeLoadBalancerPolicyTypesInputRequestTypeDef#

# DescribeLoadBalancerPolicyTypesInputRequestTypeDef definition

class DescribeLoadBalancerPolicyTypesInputRequestTypeDef(TypedDict):
    PolicyTypeNames: NotRequired[Sequence[str]],

DescribeTagsInputRequestTypeDef#

# DescribeTagsInputRequestTypeDef definition

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

DetachLoadBalancerFromSubnetsInputRequestTypeDef#

# DetachLoadBalancerFromSubnetsInputRequestTypeDef definition

class DetachLoadBalancerFromSubnetsInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    Subnets: Sequence[str],

LBCookieStickinessPolicyTypeDef#

# LBCookieStickinessPolicyTypeDef definition

class LBCookieStickinessPolicyTypeDef(TypedDict):
    PolicyName: NotRequired[str],
    CookieExpirationPeriod: NotRequired[int],

SourceSecurityGroupTypeDef#

# SourceSecurityGroupTypeDef definition

class SourceSecurityGroupTypeDef(TypedDict):
    OwnerAlias: NotRequired[str],
    GroupName: NotRequired[str],

PolicyAttributeDescriptionTypeDef#

# PolicyAttributeDescriptionTypeDef definition

class PolicyAttributeDescriptionTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeValue: NotRequired[str],

PolicyAttributeTypeDescriptionTypeDef#

# PolicyAttributeTypeDescriptionTypeDef definition

class PolicyAttributeTypeDescriptionTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeType: NotRequired[str],
    Description: NotRequired[str],
    DefaultValue: NotRequired[str],
    Cardinality: NotRequired[str],

RemoveAvailabilityZonesInputRequestTypeDef#

# RemoveAvailabilityZonesInputRequestTypeDef definition

class RemoveAvailabilityZonesInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    AvailabilityZones: Sequence[str],

TagKeyOnlyTypeDef#

# TagKeyOnlyTypeDef definition

class TagKeyOnlyTypeDef(TypedDict):
    Key: NotRequired[str],

SetLoadBalancerListenerSSLCertificateInputRequestTypeDef#

# SetLoadBalancerListenerSSLCertificateInputRequestTypeDef definition

class SetLoadBalancerListenerSSLCertificateInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    LoadBalancerPort: int,
    SSLCertificateId: str,

SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef#

# SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef definition

class SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    InstancePort: int,
    PolicyNames: Sequence[str],

SetLoadBalancerPoliciesOfListenerInputRequestTypeDef#

# SetLoadBalancerPoliciesOfListenerInputRequestTypeDef definition

class SetLoadBalancerPoliciesOfListenerInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    LoadBalancerPort: int,
    PolicyNames: Sequence[str],

AddAvailabilityZonesOutputTypeDef#

# AddAvailabilityZonesOutputTypeDef definition

class AddAvailabilityZonesOutputTypeDef(TypedDict):
    AvailabilityZones: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ApplySecurityGroupsToLoadBalancerOutputTypeDef#

# ApplySecurityGroupsToLoadBalancerOutputTypeDef definition

class ApplySecurityGroupsToLoadBalancerOutputTypeDef(TypedDict):
    SecurityGroups: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AttachLoadBalancerToSubnetsOutputTypeDef#

# AttachLoadBalancerToSubnetsOutputTypeDef definition

class AttachLoadBalancerToSubnetsOutputTypeDef(TypedDict):
    Subnets: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAccessPointOutputTypeDef#

# CreateAccessPointOutputTypeDef definition

class CreateAccessPointOutputTypeDef(TypedDict):
    DNSName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DetachLoadBalancerFromSubnetsOutputTypeDef#

# DetachLoadBalancerFromSubnetsOutputTypeDef definition

class DetachLoadBalancerFromSubnetsOutputTypeDef(TypedDict):
    Subnets: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveAvailabilityZonesOutputTypeDef#

# RemoveAvailabilityZonesOutputTypeDef definition

class RemoveAvailabilityZonesOutputTypeDef(TypedDict):
    AvailabilityZones: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddTagsInputRequestTypeDef#

# AddTagsInputRequestTypeDef definition

class AddTagsInputRequestTypeDef(TypedDict):
    LoadBalancerNames: Sequence[str],
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

TagDescriptionTypeDef#

# TagDescriptionTypeDef definition

class TagDescriptionTypeDef(TypedDict):
    LoadBalancerName: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
  1. See TagTypeDef

ConfigureHealthCheckInputRequestTypeDef#

# ConfigureHealthCheckInputRequestTypeDef definition

class ConfigureHealthCheckInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    HealthCheck: HealthCheckTypeDef,  # (1)
  1. See HealthCheckTypeDef

ConfigureHealthCheckOutputTypeDef#

# ConfigureHealthCheckOutputTypeDef definition

class ConfigureHealthCheckOutputTypeDef(TypedDict):
    HealthCheck: HealthCheckTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HealthCheckTypeDef
  2. See ResponseMetadataTypeDef

CreateAccessPointInputRequestTypeDef#

# CreateAccessPointInputRequestTypeDef definition

class CreateAccessPointInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    Listeners: Sequence[ListenerTypeDef],  # (1)
    AvailabilityZones: NotRequired[Sequence[str]],
    Subnets: NotRequired[Sequence[str]],
    SecurityGroups: NotRequired[Sequence[str]],
    Scheme: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ListenerTypeDef
  2. See TagTypeDef

CreateLoadBalancerListenerInputRequestTypeDef#

# CreateLoadBalancerListenerInputRequestTypeDef definition

class CreateLoadBalancerListenerInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    Listeners: Sequence[ListenerTypeDef],  # (1)
  1. See ListenerTypeDef

ListenerDescriptionTypeDef#

# ListenerDescriptionTypeDef definition

class ListenerDescriptionTypeDef(TypedDict):
    Listener: NotRequired[ListenerTypeDef],  # (1)
    PolicyNames: NotRequired[List[str]],
  1. See ListenerTypeDef

CreateLoadBalancerPolicyInputRequestTypeDef#

# CreateLoadBalancerPolicyInputRequestTypeDef definition

class CreateLoadBalancerPolicyInputRequestTypeDef(TypedDict):
    LoadBalancerName: str,
    PolicyName: str,
    PolicyTypeName: str,
    PolicyAttributes: NotRequired[Sequence[PolicyAttributeTypeDef]],  # (1)
  1. See PolicyAttributeTypeDef

LoadBalancerAttributesOutputTypeDef