Client library for Elastic Load Balancing

npm install --save @datafire/amazonaws_elasticloadbalancing

let amazonaws_elasticloadbalancing = require('@datafire/amazonaws_elasticloadbalancing').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Elastic Load Balancing

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:

• Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

• Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

• Gateway Load Balancer - Operates at the network layer (layer 3).

For more information, see the Elastic Load Balancing User Guide.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

amazonaws_elasticloadbalancing.AddListenerCertificates({
  "ListenerArn": "",
  "Certificates": []
}, context)

• input object
  • ListenerArn required string
  • Certificates required array

• output AddListenerCertificatesOutput

amazonaws_elasticloadbalancing.AddListenerCertificates({
  "ListenerArn": null,
  "Certificates": null
}, context)

• input object
  • Certificates required
    • items Certificate
  • ListenerArn required

• output AddListenerCertificatesOutput

amazonaws_elasticloadbalancing.AddTags({
  "ResourceArns": [],
  "Tags": []
}, context)

• input object
  • ResourceArns required array
  • Tags required array

• output AddTagsOutput

amazonaws_elasticloadbalancing.AddTags({
  "ResourceArns": null,
  "Tags": null
}, context)

• input object
  • ResourceArns required
    • items ResourceArn
  • Tags required
    • items Tag

• output AddTagsOutput

amazonaws_elasticloadbalancing.CreateListener({
  "LoadBalancerArn": "",
  "DefaultActions": []
}, context)

• input object
  • LoadBalancerArn required string
  • Protocol string
  • Port integer
  • SslPolicy string
  • Certificates array
  • DefaultActions required array
  • AlpnPolicy array
  • Tags array

• output CreateListenerOutput

amazonaws_elasticloadbalancing.CreateListener({
  "LoadBalancerArn": null,
  "DefaultActions": null
}, context)

• input object
  • AlpnPolicy
    • items AlpnPolicyValue
  • Certificates
    • items Certificate
  • DefaultActions required
    • items Action
  • LoadBalancerArn required
  • Port
  • Protocol
  • SslPolicy
  • Tags
    • items Tag

• output CreateListenerOutput

amazonaws_elasticloadbalancing.CreateLoadBalancer({
  "Name": ""
}, context)

• input object
  • Name required string
  • Subnets array
  • SubnetMappings array
  • SecurityGroups array
  • Scheme string
  • Tags array
  • Type string
  • IpAddressType string
  • CustomerOwnedIpv4Pool string

• output CreateLoadBalancerOutput

amazonaws_elasticloadbalancing.CreateLoadBalancer({
  "Name": null
}, context)

• input object
  • CustomerOwnedIpv4Pool
  • IpAddressType
  • Name required
  • Scheme
  • SecurityGroups
    • items SecurityGroupId
  • SubnetMappings
    • items SubnetMapping
  • Subnets
    • items SubnetId
  • Tags
    • items Tag
  • Type

• output CreateLoadBalancerOutput

amazonaws_elasticloadbalancing.CreateRule({
  "ListenerArn": "",
  "Conditions": [],
  "Priority": 0,
  "Actions": []
}, context)

• input object
  • ListenerArn required string
  • Conditions required array
  • Priority required integer
  • Actions required array
  • Tags array

• output CreateRuleOutput

amazonaws_elasticloadbalancing.CreateRule({
  "ListenerArn": null,
  "Conditions": null,
  "Priority": null,
  "Actions": null
}, context)

• input object
  • Actions required
    • items Action
  • Conditions required
    • items RuleCondition
  • ListenerArn required
  • Priority required
  • Tags
    • items Tag

• output CreateRuleOutput

amazonaws_elasticloadbalancing.CreateTargetGroup({
  "Name": ""
}, context)

• input object
  • Name required string
  • Protocol string
  • ProtocolVersion string
  • Port integer
  • VpcId string
  • HealthCheckProtocol string
  • HealthCheckPort string
  • HealthCheckEnabled boolean
  • HealthCheckPath string
  • HealthCheckIntervalSeconds integer
  • HealthCheckTimeoutSeconds integer
  • HealthyThresholdCount integer
  • UnhealthyThresholdCount integer
  • Matcher object
  • TargetType string
  • Tags array

• output CreateTargetGroupOutput

amazonaws_elasticloadbalancing.CreateTargetGroup({
  "Name": null
}, context)

• input object
  • HealthCheckEnabled
  • HealthCheckIntervalSeconds
  • HealthCheckPath
  • HealthCheckPort
  • HealthCheckProtocol
  • HealthCheckTimeoutSeconds
  • HealthyThresholdCount
  • Matcher
    • GrpcCode
    • HttpCode
  • Name required
  • Port
  • Protocol
  • ProtocolVersion
  • Tags
    • items Tag
  • TargetType
  • UnhealthyThresholdCount
  • VpcId

• output CreateTargetGroupOutput

amazonaws_elasticloadbalancing.DeleteListener({
  "ListenerArn": ""
}, context)

• input object
  • ListenerArn required string

• output DeleteListenerOutput

amazonaws_elasticloadbalancing.DeleteListener({
  "ListenerArn": null
}, context)

• input object
  • ListenerArn required

• output DeleteListenerOutput

amazonaws_elasticloadbalancing.DeleteLoadBalancer({
  "LoadBalancerArn": ""
}, context)

• input object
  • LoadBalancerArn required string

• output DeleteLoadBalancerOutput

amazonaws_elasticloadbalancing.DeleteLoadBalancer({
  "LoadBalancerArn": null
}, context)

• input object
  • LoadBalancerArn required

• output DeleteLoadBalancerOutput

amazonaws_elasticloadbalancing.DeleteRule({
  "RuleArn": ""
}, context)

• input object
  • RuleArn required string

• output DeleteRuleOutput

amazonaws_elasticloadbalancing.DeleteRule({
  "RuleArn": null
}, context)

• input object
  • RuleArn required

• output DeleteRuleOutput

amazonaws_elasticloadbalancing.DeleteTargetGroup({
  "TargetGroupArn": ""
}, context)

• input object
  • TargetGroupArn required string

• output DeleteTargetGroupOutput

amazonaws_elasticloadbalancing.DeleteTargetGroup({
  "TargetGroupArn": null
}, context)

• input object
  • TargetGroupArn required

• output DeleteTargetGroupOutput

amazonaws_elasticloadbalancing.DeregisterTargets({
  "TargetGroupArn": "",
  "Targets": []
}, context)

• input object
  • TargetGroupArn required string
  • Targets required array

• output DeregisterTargetsOutput

amazonaws_elasticloadbalancing.DeregisterTargets({
  "TargetGroupArn": null,
  "Targets": null
}, context)

• input object
  • TargetGroupArn required
  • Targets required
    • items TargetDescription

• output DeregisterTargetsOutput

amazonaws_elasticloadbalancing.DescribeAccountLimits({}, context)

• input object
  • Marker string
  • PageSize integer

• output DescribeAccountLimitsOutput

amazonaws_elasticloadbalancing.DescribeAccountLimits({}, context)

• input object
  • Marker
  • PageSize

• output DescribeAccountLimitsOutput

amazonaws_elasticloadbalancing.DescribeListenerCertificates({
  "ListenerArn": ""
}, context)

• input object
  • ListenerArn required string
  • Marker string
  • PageSize integer

• output DescribeListenerCertificatesOutput

amazonaws_elasticloadbalancing.DescribeListenerCertificates({
  "ListenerArn": null
}, context)

• input object
  • ListenerArn required
  • Marker
  • PageSize

• output DescribeListenerCertificatesOutput

amazonaws_elasticloadbalancing.DescribeListeners({}, context)

• input object
  • LoadBalancerArn string
  • ListenerArns array
  • Marker string
  • PageSize integer

• output DescribeListenersOutput

amazonaws_elasticloadbalancing.DescribeListeners({}, context)

• input object
  • Marker string
  • ListenerArns
    • items ListenerArn
  • LoadBalancerArn
  • Marker
  • PageSize

• output DescribeListenersOutput

amazonaws_elasticloadbalancing.DescribeLoadBalancerAttributes({
  "LoadBalancerArn": ""
}, context)

• input object
  • LoadBalancerArn required string

• output DescribeLoadBalancerAttributesOutput

amazonaws_elasticloadbalancing.DescribeLoadBalancerAttributes({
  "LoadBalancerArn": null
}, context)

• input object
  • LoadBalancerArn required

• output DescribeLoadBalancerAttributesOutput

amazonaws_elasticloadbalancing.DescribeLoadBalancers({}, context)

• input object
  • LoadBalancerArns array
  • Names array
  • Marker string
  • PageSize integer

• output DescribeLoadBalancersOutput

amazonaws_elasticloadbalancing.DescribeLoadBalancers({}, context)

• input object
  • Marker string
  • LoadBalancerArns
    • items LoadBalancerArn
  • Marker
  • Names
    • items LoadBalancerName
  • PageSize

• output DescribeLoadBalancersOutput

amazonaws_elasticloadbalancing.DescribeRules({}, context)

• input object
  • ListenerArn string
  • RuleArns array
  • Marker string
  • PageSize integer

• output DescribeRulesOutput

amazonaws_elasticloadbalancing.DescribeRules({}, context)

• input object
  • ListenerArn
  • Marker
  • PageSize
  • RuleArns
    • items RuleArn

• output DescribeRulesOutput

amazonaws_elasticloadbalancing.DescribeSSLPolicies({}, context)

• input object
  • Names array
  • Marker string
  • PageSize integer

• output DescribeSSLPoliciesOutput

amazonaws_elasticloadbalancing.DescribeSSLPolicies({}, context)

• input object
  • Marker
  • Names
    • items SslPolicyName
  • PageSize

• output DescribeSSLPoliciesOutput

amazonaws_elasticloadbalancing.DescribeTags({
  "ResourceArns": []
}, context)

• input object
  • ResourceArns required array

• output DescribeTagsOutput

amazonaws_elasticloadbalancing.DescribeTags({
  "ResourceArns": null
}, context)

• input object
  • ResourceArns required
    • items ResourceArn

• output DescribeTagsOutput

amazonaws_elasticloadbalancing.DescribeTargetGroupAttributes({
  "TargetGroupArn": ""
}, context)

• input object
  • TargetGroupArn required string

• output DescribeTargetGroupAttributesOutput

amazonaws_elasticloadbalancing.DescribeTargetGroupAttributes({
  "TargetGroupArn": null
}, context)

• input object
  • TargetGroupArn required

• output DescribeTargetGroupAttributesOutput

amazonaws_elasticloadbalancing.DescribeTargetGroups({}, context)

• input object
  • LoadBalancerArn string
  • TargetGroupArns array
  • Names array
  • Marker string
  • PageSize integer

• output DescribeTargetGroupsOutput

amazonaws_elasticloadbalancing.DescribeTargetGroups({}, context)

• input object
  • Marker string
  • LoadBalancerArn
  • Marker
  • Names
    • items TargetGroupName
  • PageSize
  • TargetGroupArns
    • items TargetGroupArn

• output DescribeTargetGroupsOutput

amazonaws_elasticloadbalancing.DescribeTargetHealth({
  "TargetGroupArn": ""
}, context)

• input object
  • TargetGroupArn required string
  • Targets array

• output DescribeTargetHealthOutput

amazonaws_elasticloadbalancing.DescribeTargetHealth({
  "TargetGroupArn": null
}, context)

• input object
  • TargetGroupArn required
  • Targets
    • items TargetDescription

• output DescribeTargetHealthOutput

amazonaws_elasticloadbalancing.ModifyListener({
  "ListenerArn": ""
}, context)

• input object
  • ListenerArn required string
  • Port integer
  • Protocol string
  • SslPolicy string
  • Certificates array
  • DefaultActions array
  • AlpnPolicy array

• output ModifyListenerOutput

amazonaws_elasticloadbalancing.ModifyListener({
  "ListenerArn": null
}, context)

• input object
  • AlpnPolicy
    • items AlpnPolicyValue
  • Certificates
    • items Certificate
  • DefaultActions
    • items Action
  • ListenerArn required
  • Port
  • Protocol
  • SslPolicy

• output ModifyListenerOutput

amazonaws_elasticloadbalancing.ModifyLoadBalancerAttributes({
  "LoadBalancerArn": "",
  "Attributes": []
}, context)

• input object
  • LoadBalancerArn required string
  • Attributes required array

• output ModifyLoadBalancerAttributesOutput

amazonaws_elasticloadbalancing.ModifyLoadBalancerAttributes({
  "LoadBalancerArn": null,
  "Attributes": null
}, context)

• input object
  • Attributes required
    • items LoadBalancerAttribute
  • LoadBalancerArn required

• output ModifyLoadBalancerAttributesOutput

amazonaws_elasticloadbalancing.ModifyRule({
  "RuleArn": ""
}, context)

• input object
  • RuleArn required string
  • Conditions array
  • Actions array

• output ModifyRuleOutput

amazonaws_elasticloadbalancing.ModifyRule({
  "RuleArn": null
}, context)

• input object
  • Actions
    • items Action
  • Conditions
    • items RuleCondition
  • RuleArn required

• output ModifyRuleOutput

amazonaws_elasticloadbalancing.ModifyTargetGroup({
  "TargetGroupArn": ""
}, context)

• input object
  • TargetGroupArn required string
  • HealthCheckProtocol string
  • HealthCheckPort string
  • HealthCheckPath string
  • HealthCheckEnabled boolean
  • HealthCheckIntervalSeconds integer
  • HealthCheckTimeoutSeconds integer
  • HealthyThresholdCount integer
  • UnhealthyThresholdCount integer
  • Matcher object

• output ModifyTargetGroupOutput

amazonaws_elasticloadbalancing.ModifyTargetGroup({
  "TargetGroupArn": null
}, context)

• input object
  • HealthCheckEnabled
  • HealthCheckIntervalSeconds
  • HealthCheckPath
  • HealthCheckPort
  • HealthCheckProtocol
  • HealthCheckTimeoutSeconds
  • HealthyThresholdCount
  • Matcher
    • GrpcCode
    • HttpCode
  • TargetGroupArn required
  • UnhealthyThresholdCount

• output ModifyTargetGroupOutput

amazonaws_elasticloadbalancing.ModifyTargetGroupAttributes({
  "TargetGroupArn": "",
  "Attributes": []
}, context)

• input object
  • TargetGroupArn required string
  • Attributes required array

• output ModifyTargetGroupAttributesOutput

amazonaws_elasticloadbalancing.ModifyTargetGroupAttributes({
  "TargetGroupArn": null,
  "Attributes": null
}, context)

• input object
  • Attributes required
    • items TargetGroupAttribute
  • TargetGroupArn required

• output ModifyTargetGroupAttributesOutput

amazonaws_elasticloadbalancing.RegisterTargets({
  "TargetGroupArn": "",
  "Targets": []
}, context)

• input object
  • TargetGroupArn required string
  • Targets required array

• output RegisterTargetsOutput

amazonaws_elasticloadbalancing.RegisterTargets({
  "TargetGroupArn": null,
  "Targets": null
}, context)

• input object
  • TargetGroupArn required
  • Targets required
    • items TargetDescription

• output RegisterTargetsOutput

amazonaws_elasticloadbalancing.RemoveListenerCertificates({
  "ListenerArn": "",
  "Certificates": []
}, context)

• input object
  • ListenerArn required string
  • Certificates required array

• output RemoveListenerCertificatesOutput

amazonaws_elasticloadbalancing.RemoveListenerCertificates({
  "ListenerArn": null,
  "Certificates": null
}, context)

• input object
  • Certificates required
    • items Certificate
  • ListenerArn required

• output RemoveListenerCertificatesOutput

amazonaws_elasticloadbalancing.RemoveTags({
  "ResourceArns": [],
  "TagKeys": []
}, context)

• input object
  • ResourceArns required array
  • TagKeys required array

• output RemoveTagsOutput

amazonaws_elasticloadbalancing.RemoveTags({
  "ResourceArns": null,
  "TagKeys": null
}, context)

• input object
  • ResourceArns required
    • items ResourceArn
  • TagKeys required
    • items TagKey

• output RemoveTagsOutput

amazonaws_elasticloadbalancing.SetIpAddressType({
  "LoadBalancerArn": "",
  "IpAddressType": ""
}, context)

• input object
  • LoadBalancerArn required string
  • IpAddressType required string

• output SetIpAddressTypeOutput

amazonaws_elasticloadbalancing.SetIpAddressType({
  "LoadBalancerArn": null,
  "IpAddressType": null
}, context)

• input object
  • IpAddressType required
  • LoadBalancerArn required

• output SetIpAddressTypeOutput

amazonaws_elasticloadbalancing.SetRulePriorities({
  "RulePriorities": []
}, context)

• input object
  • RulePriorities required array

• output SetRulePrioritiesOutput

amazonaws_elasticloadbalancing.SetRulePriorities({
  "RulePriorities": null
}, context)

• input object
  • RulePriorities required
    • items RulePriorityPair

• output SetRulePrioritiesOutput

amazonaws_elasticloadbalancing.SetSecurityGroups({
  "LoadBalancerArn": "",
  "SecurityGroups": []
}, context)

• input object
  • LoadBalancerArn required string
  • SecurityGroups required array

• output SetSecurityGroupsOutput

amazonaws_elasticloadbalancing.SetSecurityGroups({
  "LoadBalancerArn": null,
  "SecurityGroups": null
}, context)

• input object
  • LoadBalancerArn required
  • SecurityGroups required
    • items SecurityGroupId

• output SetSecurityGroupsOutput

amazonaws_elasticloadbalancing.SetSubnets({
  "LoadBalancerArn": ""
}, context)

• input object
  • LoadBalancerArn required string
  • Subnets array
  • SubnetMappings array
  • IpAddressType string

• output SetSubnetsOutput

amazonaws_elasticloadbalancing.SetSubnets({
  "LoadBalancerArn": null
}, context)

• input object
  • IpAddressType
  • LoadBalancerArn required
  • SubnetMappings
    • items SubnetMapping
  • Subnets
    • items SubnetId

• output SetSubnetsOutput

• Action object:

  Information about an action.

  Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed.

  • AuthenticateCognitoConfig
    • AuthenticationRequestExtraParams
    • OnUnauthenticatedRequest
    • Scope
    • SessionCookieName
    • SessionTimeout
    • UserPoolArn required
    • UserPoolClientId required
    • UserPoolDomain required
  • AuthenticateOidcConfig
    • AuthenticationRequestExtraParams
    • AuthorizationEndpoint required
    • ClientId required
    • ClientSecret
    • Issuer required
    • OnUnauthenticatedRequest
    • Scope
    • SessionCookieName
    • SessionTimeout
    • TokenEndpoint required
    • UseExistingClientSecret
    • UserInfoEndpoint required
  • FixedResponseConfig
    • ContentType
    • MessageBody
    • StatusCode required
  • ForwardConfig
    • TargetGroupStickinessConfig
      • DurationSeconds
      • Enabled
    • TargetGroups
      • items TargetGroupTuple
  • Order
  • RedirectConfig
    • Host
    • Path
    • Port
    • Protocol
    • Query
    • StatusCode required
  • TargetGroupArn
  • Type required

• ActionOrder integer

• ActionTypeEnum string (values: forward, authenticate-oidc, authenticate-cognito, redirect, fixed-response)

• Actions array
  • items Action

• AddListenerCertificatesInput object
  • Certificates required
    • items Certificate
  • ListenerArn required

• AddListenerCertificatesOutput object
  • Certificates
    • items Certificate

• AddTagsInput object
  • ResourceArns required
    • items ResourceArn
  • Tags required
    • items Tag

• AddTagsOutput object

• AllocationId string

• AlpnPolicyName array
  • items AlpnPolicyValue

• AlpnPolicyValue string

• AuthenticateCognitoActionAuthenticationRequestExtraParams object

• AuthenticateCognitoActionAuthenticationRequestParamName string

• AuthenticateCognitoActionAuthenticationRequestParamValue string

• AuthenticateCognitoActionConditionalBehaviorEnum string (values: deny, allow, authenticate)

• AuthenticateCognitoActionConfig object: Request parameters to use when integrating with Amazon Cognito to authenticate users.
  • AuthenticationRequestExtraParams
  • OnUnauthenticatedRequest
  • Scope
  • SessionCookieName
  • SessionTimeout
  • UserPoolArn required
  • UserPoolClientId required
  • UserPoolDomain required

• AuthenticateCognitoActionScope string

• AuthenticateCognitoActionSessionCookieName string

• AuthenticateCognitoActionSessionTimeout integer

• AuthenticateCognitoActionUserPoolArn string

• AuthenticateCognitoActionUserPoolClientId string

• AuthenticateCognitoActionUserPoolDomain string

• AuthenticateOidcActionAuthenticationRequestExtraParams object

• AuthenticateOidcActionAuthenticationRequestParamName string

• AuthenticateOidcActionAuthenticationRequestParamValue string

• AuthenticateOidcActionAuthorizationEndpoint string

• AuthenticateOidcActionClientId string

• AuthenticateOidcActionClientSecret string

• AuthenticateOidcActionConditionalBehaviorEnum string (values: deny, allow, authenticate)

• AuthenticateOidcActionConfig object: Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
  • AuthenticationRequestExtraParams
  • AuthorizationEndpoint required
  • ClientId required
  • ClientSecret
  • Issuer required
  • OnUnauthenticatedRequest
  • Scope
  • SessionCookieName
  • SessionTimeout
  • TokenEndpoint required
  • UseExistingClientSecret
  • UserInfoEndpoint required

• AuthenticateOidcActionIssuer string

• AuthenticateOidcActionScope string

• AuthenticateOidcActionSessionCookieName string

• AuthenticateOidcActionSessionTimeout integer

• AuthenticateOidcActionTokenEndpoint string

• AuthenticateOidcActionUseExistingClientSecret boolean

• AuthenticateOidcActionUserInfoEndpoint string

• AvailabilityZone object: Information about an Availability Zone.
  • LoadBalancerAddresses
    • items LoadBalancerAddress
  • OutpostId
  • SubnetId
  • ZoneName

• AvailabilityZones array
  • items AvailabilityZone

• CanonicalHostedZoneId string

• Certificate object: Information about an SSL server certificate.
  • CertificateArn
  • IsDefault

• CertificateArn string

• CertificateList array
  • items Certificate

• Cipher object: Information about a cipher used in a policy.
  • Name
  • Priority

• CipherName string

• CipherPriority integer

• Ciphers array
  • items Cipher

• ConditionFieldName string

• CreateListenerInput object
  • AlpnPolicy
    • items AlpnPolicyValue
  • Certificates
    • items Certificate
  • DefaultActions required
    • items Action
  • LoadBalancerArn required
  • Port
  • Protocol
  • SslPolicy
  • Tags
    • items Tag

• CreateListenerOutput object
  • Listeners
    • items Listener

• CreateLoadBalancerInput object
  • CustomerOwnedIpv4Pool
  • IpAddressType
  • Name required
  • Scheme
  • SecurityGroups
    • items SecurityGroupId
  • SubnetMappings
    • items SubnetMapping
  • Subnets
    • items SubnetId
  • Tags
    • items Tag
  • Type

• CreateLoadBalancerOutput object
  • LoadBalancers
    • items LoadBalancer

• CreateRuleInput object
  • Actions required
    • items Action
  • Conditions required
    • items RuleCondition
  • ListenerArn required
  • Priority required
  • Tags
    • items Tag

• CreateRuleOutput object
  • Rules
    • items Rule

• CreateTargetGroupInput object
  • HealthCheckEnabled
  • HealthCheckIntervalSeconds
  • HealthCheckPath
  • HealthCheckPort
  • HealthCheckProtocol
  • HealthCheckTimeoutSeconds
  • HealthyThresholdCount
  • Matcher
    • GrpcCode
    • HttpCode
  • Name required
  • Port
  • Protocol
  • ProtocolVersion
  • Tags
    • items Tag
  • TargetType
  • UnhealthyThresholdCount
  • VpcId

• CreateTargetGroupOutput object
  • TargetGroups
    • items TargetGroup

• CreatedTime string

• CustomerOwnedIpv4Pool string

• DNSName string

• Default boolean

• DeleteListenerInput object
  • ListenerArn required

• DeleteListenerOutput object

• DeleteLoadBalancerInput object
  • LoadBalancerArn required

• DeleteLoadBalancerOutput object

• DeleteRuleInput object
  • RuleArn required

• DeleteRuleOutput object

• DeleteTargetGroupInput object
  • TargetGroupArn required

• DeleteTargetGroupOutput object

• DeregisterTargetsInput object
  • TargetGroupArn required
  • Targets required
    • items TargetDescription

• DeregisterTargetsOutput object

• DescribeAccountLimitsInput object
  • Marker
  • PageSize

• DescribeAccountLimitsOutput object
  • Limits
    • items Limit
  • NextMarker

• DescribeListenerCertificatesInput object
  • ListenerArn required
  • Marker
  • PageSize

• DescribeListenerCertificatesOutput object
  • Certificates
    • items Certificate
  • NextMarker

• DescribeListenersInput object
  • ListenerArns
    • items ListenerArn
  • LoadBalancerArn
  • Marker
  • PageSize

• DescribeListenersOutput object
  • Listeners
    • items Listener
  • NextMarker

• DescribeLoadBalancerAttributesInput object
  • LoadBalancerArn required

• DescribeLoadBalancerAttributesOutput object
  • Attributes
    • items LoadBalancerAttribute

• DescribeLoadBalancersInput object
  • LoadBalancerArns
    • items LoadBalancerArn
  • Marker
  • Names
    • items LoadBalancerName
  • PageSize

• DescribeLoadBalancersOutput object
  • LoadBalancers
    • items LoadBalancer
  • NextMarker

• DescribeRulesInput object
  • ListenerArn
  • Marker
  • PageSize
  • RuleArns
    • items RuleArn

• DescribeRulesOutput object
  • NextMarker
  • Rules
    • items Rule

• DescribeSSLPoliciesInput object
  • Marker
  • Names
    • items SslPolicyName
  • PageSize

• DescribeSSLPoliciesOutput object
  • NextMarker
  • SslPolicies
    • items SslPolicy

• DescribeTagsInput object
  • ResourceArns required
    • items ResourceArn

• DescribeTagsOutput object
  • TagDescriptions
    • items TagDescription

• DescribeTargetGroupAttributesInput object
  • TargetGroupArn required

• DescribeTargetGroupAttributesOutput object
  • Attributes
    • items TargetGroupAttribute

• DescribeTargetGroupsInput object
  • LoadBalancerArn
  • Marker
  • Names
    • items TargetGroupName
  • PageSize
  • TargetGroupArns
    • items TargetGroupArn

• DescribeTargetGroupsOutput object
  • NextMarker
  • TargetGroups
    • items TargetGroup

• DescribeTargetHealthInput object
  • TargetGroupArn required
  • Targets
    • items TargetDescription

• DescribeTargetHealthOutput object
  • TargetHealthDescriptions
    • items TargetHealthDescription

• Description string

• FixedResponseActionConfig object: Information about an action that returns a custom HTTP response.
  • ContentType
  • MessageBody
  • StatusCode required

• FixedResponseActionContentType string

• FixedResponseActionMessage string

• FixedResponseActionStatusCode string

• ForwardActionConfig object: Information about a forward action.
  • TargetGroupStickinessConfig
    • DurationSeconds
    • Enabled
  • TargetGroups
    • items TargetGroupTuple

• GrpcCode string

• HealthCheckEnabled boolean

• HealthCheckIntervalSeconds integer

• HealthCheckPort string

• HealthCheckThresholdCount integer

• HealthCheckTimeoutSeconds integer

• HostHeaderConditionConfig object: Information about a host header condition.
  • Values
    • items StringValue

• HttpCode string

• HttpHeaderConditionConfig object:

  Information about an HTTP header condition.

  There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

  • HttpHeaderName
  • Values
    • items StringValue

• HttpHeaderConditionName string

• HttpRequestMethodConditionConfig object:

  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.

  • Values
    • items StringValue

• IPv6Address string

• IpAddress string

• IpAddressType string (values: ipv4, dualstack)

• IsDefault boolean

• Limit object: Information about an Elastic Load Balancing resource limit for your AWS account.
  • Max
  • Name

• Limits array
  • items Limit

• ListOfString array
  • items StringValue

• Listener object: Information about a listener.
  • AlpnPolicy
    • items AlpnPolicyValue
  • Certificates
    • items Certificate
  • DefaultActions
    • items Action
  • ListenerArn
  • LoadBalancerArn
  • Port
  • Protocol
  • SslPolicy

• ListenerArn string

• ListenerArns array
  • items ListenerArn

• Listeners array
  • items Listener

• LoadBalancer object: Information about a load balancer.
  • AvailabilityZones
    • items AvailabilityZone
  • CanonicalHostedZoneId
  • CreatedTime
  • CustomerOwnedIpv4Pool
  • DNSName
  • IpAddressType
  • LoadBalancerArn
  • LoadBalancerName
  • Scheme
  • SecurityGroups
    • items SecurityGroupId
  • State
    • Code
    • Reason
  • Type
  • VpcId

• LoadBalancerAddress object: Information about a static IP address for a load balancer.
  • AllocationId
  • IPv6Address
  • IpAddress
  • PrivateIPv4Address

• LoadBalancerAddresses array
  • items LoadBalancerAddress

• LoadBalancerArn string

• LoadBalancerArns array
  • items LoadBalancerArn

• LoadBalancerAttribute object: Information about a load balancer attribute.
  • Key
  • Value

• LoadBalancerAttributeKey string

• LoadBalancerAttributeValue string

• LoadBalancerAttributes array
  • items LoadBalancerAttribute

• LoadBalancerName string

• LoadBalancerNames array
  • items LoadBalancerName

• LoadBalancerSchemeEnum string (values: internet-facing, internal)

• LoadBalancerState object: Information about the state of the load balancer.
  • Code
  • Reason

• LoadBalancerStateEnum string (values: active, provisioning, active_impaired, failed)

• LoadBalancerTypeEnum string (values: application, network, gateway)

• LoadBalancers array
  • items LoadBalancer

• Marker string

• Matcher object: 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.
  • GrpcCode
  • HttpCode

• Max string

• ModifyListenerInput object
  • AlpnPolicy
    • items AlpnPolicyValue
  • Certificates
    • items Certificate
  • DefaultActions
    • items Action
  • ListenerArn required
  • Port
  • Protocol
  • SslPolicy

• ModifyListenerOutput object
  • Listeners
    • items Listener

• ModifyLoadBalancerAttributesInput object
  • Attributes required
    • items LoadBalancerAttribute
  • LoadBalancerArn required

• ModifyLoadBalancerAttributesOutput object
  • Attributes
    • items LoadBalancerAttribute

• ModifyRuleInput object
  • Actions
    • items Action
  • Conditions
    • items RuleCondition
  • RuleArn required

• ModifyRuleOutput object
  • Rules
    • items Rule

• ModifyTargetGroupAttributesInput object
  • Attributes required
    • items TargetGroupAttribute
  • TargetGroupArn required

• ModifyTargetGroupAttributesOutput object
  • Attributes
    • items TargetGroupAttribute

• ModifyTargetGroupInput object
  • HealthCheckEnabled
  • HealthCheckIntervalSeconds
  • HealthCheckPath
  • HealthCheckPort
  • HealthCheckProtocol
  • HealthCheckTimeoutSeconds
  • HealthyThresholdCount
  • Matcher
    • GrpcCode
    • HttpCode
  • TargetGroupArn required
  • UnhealthyThresholdCount

• ModifyTargetGroupOutput object
  • TargetGroups
    • items TargetGroup

• Name string

• OutpostId string

• PageSize integer

• Path string

• PathPatternConditionConfig object: Information about a path pattern condition.
  • Values
    • items StringValue

• Port integer

• PrivateIPv4Address string

• ProtocolEnum string (values: HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE)

• ProtocolVersion string

• QueryStringConditionConfig object:

  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.

  • Values
    • items QueryStringKeyValuePair

• QueryStringKeyValuePair object: Information about a key/value pair.
  • Key
  • Value

• QueryStringKeyValuePairList array
  • items QueryStringKeyValuePair

• RedirectActionConfig object:

  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".

  • Host
  • Path
  • Port
  • Protocol
  • Query
  • StatusCode required

• RedirectActionHost string

• RedirectActionPath string

• RedirectActionPort string

• RedirectActionProtocol string

• RedirectActionQuery string

• RedirectActionStatusCodeEnum string (values: HTTP_301, HTTP_302)

• RegisterTargetsInput object
  • TargetGroupArn required
  • Targets required
    • items TargetDescription

• RegisterTargetsOutput object

• RemoveListenerCertificatesInput object
  • Certificates required
    • items Certificate
  • ListenerArn required

• RemoveListenerCertificatesOutput object

• RemoveTagsInput object
  • ResourceArns required
    • items ResourceArn
  • TagKeys required
    • items TagKey

• RemoveTagsOutput object

• ResourceArn string

• ResourceArns array
  • items ResourceArn

• Rule object: Information about a rule.
  • Actions
    • items Action
  • Conditions
    • items RuleCondition
  • IsDefault
  • Priority
  • RuleArn

• RuleArn string

• RuleArns array
  • items RuleArn

• RuleCondition object:

  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, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.

  • Field
  • HostHeaderConfig
    • Values
      • items StringValue
  • HttpHeaderConfig
    • HttpHeaderName
    • Values
      • items StringValue
  • HttpRequestMethodConfig
    • Values
      • items StringValue
  • PathPatternConfig
    • Values
      • items StringValue
  • QueryStringConfig
    • Values
      • items QueryStringKeyValuePair
  • SourceIpConfig
    • Values
      • items StringValue
  • Values
    • items StringValue

• RuleConditionList array
  • items RuleCondition

• RulePriority integer

• RulePriorityList array
  • items RulePriorityPair

• RulePriorityPair object: Information about the priorities for the rules for a listener.
  • Priority
  • RuleArn

• Rules array
  • items Rule

• SecurityGroupId string

• SecurityGroups array
  • items SecurityGroupId

• SetIpAddressTypeInput object
  • IpAddressType required
  • LoadBalancerArn required

• SetIpAddressTypeOutput object
  • IpAddressType

• SetRulePrioritiesInput object
  • RulePriorities required
    • items RulePriorityPair

• SetRulePrioritiesOutput object
  • Rules
    • items Rule

• SetSecurityGroupsInput object
  • LoadBalancerArn required
  • SecurityGroups required
    • items SecurityGroupId

• SetSecurityGroupsOutput object
  • SecurityGroupIds
    • items SecurityGroupId

• SetSubnetsInput object
  • IpAddressType
  • LoadBalancerArn required
  • SubnetMappings
    • items SubnetMapping
  • Subnets
    • items SubnetId

• SetSubnetsOutput object
  • AvailabilityZones
    • items AvailabilityZone
  • IpAddressType

• SourceIpConditionConfig object:

  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.

  • Values
    • items StringValue

• SslPolicies array
  • items SslPolicy

• SslPolicy object: Information about a policy used for SSL negotiation.
  • Ciphers
    • items Cipher
  • Name
  • SslProtocols
    • items SslProtocol

• SslPolicyName string

• SslPolicyNames array
  • items SslPolicyName

• SslProtocol string

• SslProtocols array
  • items SslProtocol

• StateReason string

• String string

• StringValue string

• SubnetId string

• SubnetMapping object: Information about a subnet mapping.
  • AllocationId
  • IPv6Address
  • PrivateIPv4Address
  • SubnetId

• SubnetMappings array
  • items SubnetMapping

• Subnets array
  • items SubnetId

• Tag object: Information about a tag.
  • Key required
  • Value

• TagDescription object: The tags associated with a resource.
  • ResourceArn
  • Tags
    • items Tag

• TagDescriptions array
  • items TagDescription

• TagKey string

• TagKeys array
  • items TagKey

• TagList array
  • items Tag

• TagValue string

• TargetDescription object: Information about a target.
  • AvailabilityZone
  • Id required
  • Port

• TargetDescriptions array
  • items TargetDescription

• TargetGroup object: Information about a target group.
  • HealthCheckEnabled
  • HealthCheckIntervalSeconds
  • HealthCheckPath
  • HealthCheckPort
  • HealthCheckProtocol
  • HealthCheckTimeoutSeconds
  • HealthyThresholdCount
  • LoadBalancerArns
    • items LoadBalancerArn
  • Matcher
    • GrpcCode
    • HttpCode
  • Port
  • Protocol
  • ProtocolVersion
  • TargetGroupArn
  • TargetGroupName
  • TargetType
  • UnhealthyThresholdCount
  • VpcId

• TargetGroupArn string

• TargetGroupArns array
  • items TargetGroupArn

• TargetGroupAttribute object: Information about a target group attribute.
  • Key
  • Value

• TargetGroupAttributeKey string

• TargetGroupAttributeValue string

• TargetGroupAttributes array
  • items TargetGroupAttribute

• TargetGroupList array
  • items TargetGroupTuple

• TargetGroupName string

• TargetGroupNames array
  • items TargetGroupName

• TargetGroupStickinessConfig object: Information about the target group stickiness for a rule.
  • DurationSeconds
  • Enabled

• TargetGroupStickinessDurationSeconds integer

• TargetGroupStickinessEnabled boolean

• TargetGroupTuple object: Information about how traffic will be distributed between multiple target groups in a forward rule.
  • TargetGroupArn
  • Weight

• TargetGroupWeight integer

• TargetGroups array
  • items TargetGroup

• TargetHealth object: Information about the current health of a target.
  • Description
  • Reason
  • State

• TargetHealthDescription object: Information about the health of a target.
  • HealthCheckPort
  • Target
    • AvailabilityZone
    • Id required
    • Port
  • TargetHealth
    • Description
    • Reason
    • State

• TargetHealthDescriptions array
  • items TargetHealthDescription

• TargetHealthReasonEnum string (values: Elb.RegistrationInProgress, Elb.InitialHealthChecking, Target.ResponseCodeMismatch, Target.Timeout, Target.FailedHealthChecks, Target.NotRegistered, Target.NotInUse, Target.DeregistrationInProgress, Target.InvalidState, Target.IpUnusable, Target.HealthCheckDisabled, Elb.InternalError)

• TargetHealthStateEnum string (values: initial, healthy, unhealthy, unused, draining, unavailable)

• TargetId string

• TargetTypeEnum string (values: instance, ip, lambda)

• VpcId string

• ZoneName string