Elastic Load Balancing 2015-12-01

AddListenerCertificates

$result = $client->addListenerCertificates([/* ... */]);
$promise = $client->addListenerCertificatesAsync([/* ... */]);

Parameter Syntax

$result = $client->addListenerCertificates([
    'Certificates' => [ // REQUIRED
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

• TooManyCertificatesException:

  You've reached the limit on the number of certificates per load balancer.

• CertificateNotFoundException:

  The specified certificate does not exist.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->addTags([
    'ResourceArns' => ['<string>', ...], // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• DuplicateTagKeysException:

  A tag key was specified more than once.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• ListenerNotFoundException:

  The specified listener does not exist.

• RuleNotFoundException:

  The specified rule does not exist.

Examples

Example 1: To add tags to a load balancer

This example adds the specified tags to the specified load balancer.

$result = $client->addTags([
    'ResourceArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    ],
    'Tags' => [
        [
            'Key' => 'project',
            'Value' => 'lima',
        ],
        [
            'Key' => 'department',
            'Value' => 'digital-media',
        ],
    ],
]);

CreateListener

$result = $client->createListener([/* ... */]);
$promise = $client->createListenerAsync([/* ... */]);

Parameter Syntax

$result = $client->createListener([
    'AlpnPolicy' => ['<string>', ...],
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
    'DefaultActions' => [ // REQUIRED
        [
            'AuthenticateCognitoConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'UserPoolArn' => '<string>', // REQUIRED
                'UserPoolClientId' => '<string>', // REQUIRED
                'UserPoolDomain' => '<string>', // REQUIRED
            ],
            'AuthenticateOidcConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'AuthorizationEndpoint' => '<string>', // REQUIRED
                'ClientId' => '<string>', // REQUIRED
                'ClientSecret' => '<string>',
                'Issuer' => '<string>', // REQUIRED
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'TokenEndpoint' => '<string>', // REQUIRED
                'UseExistingClientSecret' => true || false,
                'UserInfoEndpoint' => '<string>', // REQUIRED
            ],
            'FixedResponseConfig' => [
                'ContentType' => '<string>',
                'MessageBody' => '<string>',
                'StatusCode' => '<string>', // REQUIRED
            ],
            'ForwardConfig' => [
                'TargetGroupStickinessConfig' => [
                    'DurationSeconds' => <integer>,
                    'Enabled' => true || false,
                ],
                'TargetGroups' => [
                    [
                        'TargetGroupArn' => '<string>',
                        'Weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'Order' => <integer>,
            'RedirectConfig' => [
                'Host' => '<string>',
                'Path' => '<string>',
                'Port' => '<string>',
                'Protocol' => '<string>',
                'Query' => '<string>',
                'StatusCode' => 'HTTP_301|HTTP_302', // REQUIRED
            ],
            'TargetGroupArn' => '<string>',
            'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response', // REQUIRED
        ],
        // ...
    ],
    'LoadBalancerArn' => '<string>', // REQUIRED
    'Port' => <integer>,
    'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
    'SslPolicy' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Listeners' => [
        [
            'AlpnPolicy' => ['<string>', ...],
            'Certificates' => [
                [
                    'CertificateArn' => '<string>',
                    'IsDefault' => true || false,
                ],
                // ...
            ],
            'DefaultActions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'ListenerArn' => '<string>',
            'LoadBalancerArn' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'SslPolicy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• DuplicateListenerException:

  A listener with the specified port already exists.

• TooManyListenersException:

  You've reached the limit on the number of listeners per load balancer.

• TooManyCertificatesException:

  You've reached the limit on the number of certificates per load balancer.

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• TargetGroupAssociationLimitException:

  You've reached the limit on the number of load balancers per target group.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• IncompatibleProtocolsException:

  The specified configuration is not valid with this protocol.

• SSLPolicyNotFoundException:

  The specified SSL policy does not exist.

• CertificateNotFoundException:

  The specified certificate does not exist.

• UnsupportedProtocolException:

  The specified protocol is not supported.

• TooManyRegistrationsForTargetIdException:

  You've reached the limit on the number of times a target can be registered with a load balancer.

• TooManyTargetsException:

  You've reached the limit on the number of targets.

• TooManyActionsException:

  You've reached the limit on the number of actions per rule.

• InvalidLoadBalancerActionException:

  The requested action is not valid.

• TooManyUniqueTargetGroupsPerLoadBalancerException:

  You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

• ALPNPolicyNotSupportedException:

  The specified ALPN policy is not supported.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

Examples

Example 1: To create an HTTP listener

This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.

$result = $client->createListener([
    'DefaultActions' => [
        [
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'Type' => 'forward',
        ],
    ],
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    'Port' => 80,
    'Protocol' => 'HTTP',
]);

Result syntax:

[
    'Listeners' => [
        [
            'DefaultActions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Port' => 80,
            'Protocol' => 'HTTP',
        ],
    ],
]

Example 2: To create an HTTPS listener

This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).

$result = $client->createListener([
    'Certificates' => [
        [
            'CertificateArn' => 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
        ],
    ],
    'DefaultActions' => [
        [
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'Type' => 'forward',
        ],
    ],
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    'Port' => 443,
    'Protocol' => 'HTTPS',
    'SslPolicy' => 'ELBSecurityPolicy-2015-05',
]);

Result syntax:

[
    'Listeners' => [
        [
            'Certificates' => [
                [
                    'CertificateArn' => 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
                ],
            ],
            'DefaultActions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Port' => 443,
            'Protocol' => 'HTTPS',
            'SslPolicy' => 'ELBSecurityPolicy-2015-05',
        ],
    ],
]

CreateLoadBalancer

$result = $client->createLoadBalancer([/* ... */]);
$promise = $client->createLoadBalancerAsync([/* ... */]);

Parameter Syntax

$result = $client->createLoadBalancer([
    'CustomerOwnedIpv4Pool' => '<string>',
    'IpAddressType' => 'ipv4|dualstack',
    'Name' => '<string>', // REQUIRED
    'Scheme' => 'internet-facing|internal',
    'SecurityGroups' => ['<string>', ...],
    'SubnetMappings' => [
        [
            'AllocationId' => '<string>',
            'IPv6Address' => '<string>',
            'PrivateIPv4Address' => '<string>',
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'Subnets' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => 'application|network|gateway',
]);

Parameter Details

Result Syntax

[
    'LoadBalancers' => [
        [
            'AvailabilityZones' => [
                [
                    'LoadBalancerAddresses' => [
                        [
                            'AllocationId' => '<string>',
                            'IPv6Address' => '<string>',
                            'IpAddress' => '<string>',
                            'PrivateIPv4Address' => '<string>',
                        ],
                        // ...
                    ],
                    'OutpostId' => '<string>',
                    'SubnetId' => '<string>',
                    'ZoneName' => '<string>',
                ],
                // ...
            ],
            'CanonicalHostedZoneId' => '<string>',
            'CreatedTime' => <DateTime>,
            'CustomerOwnedIpv4Pool' => '<string>',
            'DNSName' => '<string>',
            'IpAddressType' => 'ipv4|dualstack',
            'LoadBalancerArn' => '<string>',
            'LoadBalancerName' => '<string>',
            'Scheme' => 'internet-facing|internal',
            'SecurityGroups' => ['<string>', ...],
            'State' => [
                'Code' => 'active|provisioning|active_impaired|failed',
                'Reason' => '<string>',
            ],
            'Type' => 'application|network|gateway',
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• DuplicateLoadBalancerNameException:

  A load balancer with the specified name already exists.

• TooManyLoadBalancersException:

  You've reached the limit on the number of load balancers for your Amazon Web Services account.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• SubnetNotFoundException:

  The specified subnet does not exist.

• InvalidSubnetException:

  The specified subnet is out of available addresses.

• InvalidSecurityGroupException:

  The specified security group does not exist.

• InvalidSchemeException:

  The requested scheme is not valid.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

• DuplicateTagKeysException:

  A tag key was specified more than once.

• ResourceInUseException:

  A specified resource is in use.

• AllocationIdNotFoundException:

  The specified allocation ID does not exist.

• AvailabilityZoneNotSupportedException:

  The specified Availability Zone is not supported.

• OperationNotPermittedException:

  This operation is not allowed.

Examples

Example 1: To create an Internet-facing load balancer

This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.

$result = $client->createLoadBalancer([
    'Name' => 'my-load-balancer',
    'Subnets' => [
        'subnet-b7d581c0',
        'subnet-8360a9e7',
    ],
]);

Result syntax:

[
    'LoadBalancers' => [
        [
            'AvailabilityZones' => [
                [
                    'SubnetId' => 'subnet-8360a9e7',
                    'ZoneName' => 'us-west-2a',
                ],
                [
                    'SubnetId' => 'subnet-b7d581c0',
                    'ZoneName' => 'us-west-2b',
                ],
            ],
            'CanonicalHostedZoneId' => 'Z2P70J7EXAMPLE',
            'CreatedTime' => ,
            'DNSName' => 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'LoadBalancerName' => 'my-load-balancer',
            'Scheme' => 'internet-facing',
            'SecurityGroups' => [
                'sg-5943793c',
            ],
            'State' => [
                'Code' => 'provisioning',
            ],
            'Type' => 'application',
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

Example 2: To create an internal load balancer

This example creates an internal load balancer and enables the Availability Zones for the specified subnets.

$result = $client->createLoadBalancer([
    'Name' => 'my-internal-load-balancer',
    'Scheme' => 'internal',
    'SecurityGroups' => [
    ],
    'Subnets' => [
        'subnet-b7d581c0',
        'subnet-8360a9e7',
    ],
]);

Result syntax:

[
    'LoadBalancers' => [
        [
            'AvailabilityZones' => [
                [
                    'SubnetId' => 'subnet-8360a9e7',
                    'ZoneName' => 'us-west-2a',
                ],
                [
                    'SubnetId' => 'subnet-b7d581c0',
                    'ZoneName' => 'us-west-2b',
                ],
            ],
            'CanonicalHostedZoneId' => 'Z2P70J7EXAMPLE',
            'CreatedTime' => ,
            'DNSName' => 'internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2',
            'LoadBalancerName' => 'my-internal-load-balancer',
            'Scheme' => 'internal',
            'SecurityGroups' => [
                'sg-5943793c',
            ],
            'State' => [
                'Code' => 'provisioning',
            ],
            'Type' => 'application',
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

Parameter Syntax

$result = $client->createRule([
    'Actions' => [ // REQUIRED
        [
            'AuthenticateCognitoConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'UserPoolArn' => '<string>', // REQUIRED
                'UserPoolClientId' => '<string>', // REQUIRED
                'UserPoolDomain' => '<string>', // REQUIRED
            ],
            'AuthenticateOidcConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'AuthorizationEndpoint' => '<string>', // REQUIRED
                'ClientId' => '<string>', // REQUIRED
                'ClientSecret' => '<string>',
                'Issuer' => '<string>', // REQUIRED
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'TokenEndpoint' => '<string>', // REQUIRED
                'UseExistingClientSecret' => true || false,
                'UserInfoEndpoint' => '<string>', // REQUIRED
            ],
            'FixedResponseConfig' => [
                'ContentType' => '<string>',
                'MessageBody' => '<string>',
                'StatusCode' => '<string>', // REQUIRED
            ],
            'ForwardConfig' => [
                'TargetGroupStickinessConfig' => [
                    'DurationSeconds' => <integer>,
                    'Enabled' => true || false,
                ],
                'TargetGroups' => [
                    [
                        'TargetGroupArn' => '<string>',
                        'Weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'Order' => <integer>,
            'RedirectConfig' => [
                'Host' => '<string>',
                'Path' => '<string>',
                'Port' => '<string>',
                'Protocol' => '<string>',
                'Query' => '<string>',
                'StatusCode' => 'HTTP_301|HTTP_302', // REQUIRED
            ],
            'TargetGroupArn' => '<string>',
            'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response', // REQUIRED
        ],
        // ...
    ],
    'Conditions' => [ // REQUIRED
        [
            'Field' => '<string>',
            'HostHeaderConfig' => [
                'Values' => ['<string>', ...],
            ],
            'HttpHeaderConfig' => [
                'HttpHeaderName' => '<string>',
                'Values' => ['<string>', ...],
            ],
            'HttpRequestMethodConfig' => [
                'Values' => ['<string>', ...],
            ],
            'PathPatternConfig' => [
                'Values' => ['<string>', ...],
            ],
            'QueryStringConfig' => [
                'Values' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'SourceIpConfig' => [
                'Values' => ['<string>', ...],
            ],
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'ListenerArn' => '<string>', // REQUIRED
    'Priority' => <integer>, // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'Conditions' => [
                [
                    'Field' => '<string>',
                    'HostHeaderConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'HttpHeaderConfig' => [
                        'HttpHeaderName' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    'HttpRequestMethodConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'PathPatternConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'QueryStringConfig' => [
                        'Values' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SourceIpConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IsDefault' => true || false,
            'Priority' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• PriorityInUseException:

  The specified priority is in use.

• TooManyTargetGroupsException:

  You've reached the limit on the number of target groups for your Amazon Web Services account.

• TooManyRulesException:

  You've reached the limit on the number of rules per load balancer.

• TargetGroupAssociationLimitException:

  You've reached the limit on the number of load balancers per target group.

• IncompatibleProtocolsException:

  The specified configuration is not valid with this protocol.

• ListenerNotFoundException:

  The specified listener does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• TooManyRegistrationsForTargetIdException:

  You've reached the limit on the number of times a target can be registered with a load balancer.

• TooManyTargetsException:

  You've reached the limit on the number of targets.

• UnsupportedProtocolException:

  The specified protocol is not supported.

• TooManyActionsException:

  You've reached the limit on the number of actions per rule.

• InvalidLoadBalancerActionException:

  The requested action is not valid.

• TooManyUniqueTargetGroupsPerLoadBalancerException:

  You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

Examples

Example 1: To create a rule

This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).

$result = $client->createRule([
    'Actions' => [
        [
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'Type' => 'forward',
        ],
    ],
    'Conditions' => [
        [
            'Field' => 'path-pattern',
            'Values' => [
                '/img/*',
            ],
        ],
    ],
    'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
    'Priority' => 10,
]);

Result syntax:

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'Conditions' => [
                [
                    'Field' => 'path-pattern',
                    'Values' => [
                        '/img/*',
                    ],
                ],
            ],
            'IsDefault' => ,
            'Priority' => '10',
            'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
        ],
    ],
]

CreateTargetGroup

$result = $client->createTargetGroup([/* ... */]);
$promise = $client->createTargetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createTargetGroup([
    'HealthCheckEnabled' => true || false,
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => '<string>',
    'HealthCheckProtocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
    'HealthCheckTimeoutSeconds' => <integer>,
    'HealthyThresholdCount' => <integer>,
    'IpAddressType' => 'ipv4|ipv6',
    'Matcher' => [
        'GrpcCode' => '<string>',
        'HttpCode' => '<string>',
    ],
    'Name' => '<string>', // REQUIRED
    'Port' => <integer>,
    'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
    'ProtocolVersion' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetType' => 'instance|ip|lambda|alb',
    'UnhealthyThresholdCount' => <integer>,
    'VpcId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'TargetGroups' => [
        [
            'HealthCheckEnabled' => true || false,
            'HealthCheckIntervalSeconds' => <integer>,
            'HealthCheckPath' => '<string>',
            'HealthCheckPort' => '<string>',
            'HealthCheckProtocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'HealthCheckTimeoutSeconds' => <integer>,
            'HealthyThresholdCount' => <integer>,
            'IpAddressType' => 'ipv4|ipv6',
            'LoadBalancerArns' => ['<string>', ...],
            'Matcher' => [
                'GrpcCode' => '<string>',
                'HttpCode' => '<string>',
            ],
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'ProtocolVersion' => '<string>',
            'TargetGroupArn' => '<string>',
            'TargetGroupName' => '<string>',
            'TargetType' => 'instance|ip|lambda|alb',
            'UnhealthyThresholdCount' => <integer>,
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• DuplicateTargetGroupNameException:

  A target group with the specified name already exists.

• TooManyTargetGroupsException:

  You've reached the limit on the number of target groups for your Amazon Web Services account.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

Examples

Example 1: To create a target group

This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.

$result = $client->createTargetGroup([
    'Name' => 'my-targets',
    'Port' => 80,
    'Protocol' => 'HTTP',
    'VpcId' => 'vpc-3ac0fb5f',
]);

Result syntax:

[
    'TargetGroups' => [
        [
            'HealthCheckIntervalSeconds' => 30,
            'HealthCheckPath' => '/',
            'HealthCheckPort' => 'traffic-port',
            'HealthCheckProtocol' => 'HTTP',
            'HealthCheckTimeoutSeconds' => 5,
            'HealthyThresholdCount' => 5,
            'Matcher' => [
                'HttpCode' => '200',
            ],
            'Port' => 80,
            'Protocol' => 'HTTP',
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'TargetGroupName' => 'my-targets',
            'UnhealthyThresholdCount' => 2,
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

DeleteListener

$result = $client->deleteListener([/* ... */]);
$promise = $client->deleteListenerAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteListener([
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

• ResourceInUseException:

  A specified resource is in use.

Examples

Example 1: To delete a listener

This example deletes the specified listener.

$result = $client->deleteListener([
    'ListenerArn' => 'arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
]);

DeleteLoadBalancer

$result = $client->deleteLoadBalancer([/* ... */]);
$promise = $client->deleteLoadBalancerAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteLoadBalancer([
    'LoadBalancerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• OperationNotPermittedException:

  This operation is not allowed.

• ResourceInUseException:

  A specified resource is in use.

Examples

Example 1: To delete a load balancer

This example deletes the specified load balancer.

$result = $client->deleteLoadBalancer([
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
]);

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRule([
    'RuleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• RuleNotFoundException:

  The specified rule does not exist.

• OperationNotPermittedException:

  This operation is not allowed.

Examples

Example 1: To delete a rule

This example deletes the specified rule.

$result = $client->deleteRule([
    'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
]);

DeleteTargetGroup

$result = $client->deleteTargetGroup([/* ... */]);
$promise = $client->deleteTargetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTargetGroup([
    'TargetGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceInUseException:

  A specified resource is in use.

Examples

Example 1: To delete a target group

This example deletes the specified target group.

$result = $client->deleteTargetGroup([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
]);

DeregisterTargets

$result = $client->deregisterTargets([/* ... */]);
$promise = $client->deregisterTargetsAsync([/* ... */]);

Parameter Syntax

$result = $client->deregisterTargets([
    'TargetGroupArn' => '<string>', // REQUIRED
    'Targets' => [ // REQUIRED
        [
            'AvailabilityZone' => '<string>',
            'Id' => '<string>', // REQUIRED
            'Port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• TargetGroupNotFoundException:

  The specified target group does not exist.

• InvalidTargetException:

  The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

Examples

Example 1: To deregister a target from a target group

This example deregisters the specified instance from the specified target group.

$result = $client->deregisterTargets([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    'Targets' => [
        [
            'Id' => 'i-0f76fade',
        ],
    ],
]);

DescribeAccountLimits

$result = $client->describeAccountLimits([/* ... */]);
$promise = $client->describeAccountLimitsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAccountLimits([
    'Marker' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Limits' => [
        [
            'Max' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeListenerCertificates

$result = $client->describeListenerCertificates([/* ... */]);
$promise = $client->describeListenerCertificatesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeListenerCertificates([
    'ListenerArn' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

DescribeListeners

$result = $client->describeListeners([/* ... */]);
$promise = $client->describeListenersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeListeners([
    'ListenerArns' => ['<string>', ...],
    'LoadBalancerArn' => '<string>',
    'Marker' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Listeners' => [
        [
            'AlpnPolicy' => ['<string>', ...],
            'Certificates' => [
                [
                    'CertificateArn' => '<string>',
                    'IsDefault' => true || false,
                ],
                // ...
            ],
            'DefaultActions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'ListenerArn' => '<string>',
            'LoadBalancerArn' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'SslPolicy' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• UnsupportedProtocolException:

  The specified protocol is not supported.

Examples

Example 1: To describe a listener

This example describes the specified listener.

$result = $client->describeListeners([
    'ListenerArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
    ],
]);

Result syntax:

[
    'Listeners' => [
        [
            'DefaultActions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Port' => 80,
            'Protocol' => 'HTTP',
        ],
    ],
]

DescribeLoadBalancerAttributes

$result = $client->describeLoadBalancerAttributes([/* ... */]);
$promise = $client->describeLoadBalancerAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLoadBalancerAttributes([
    'LoadBalancerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

Examples

Example 1: To describe load balancer attributes

This example describes the attributes of the specified load balancer.

$result = $client->describeLoadBalancerAttributes([
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'access_logs.s3.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'idle_timeout.timeout_seconds',
            'Value' => '60',
        ],
        [
            'Key' => 'access_logs.s3.prefix',
            'Value' => '',
        ],
        [
            'Key' => 'deletion_protection.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'access_logs.s3.bucket',
            'Value' => '',
        ],
    ],
]

DescribeLoadBalancers

$result = $client->describeLoadBalancers([/* ... */]);
$promise = $client->describeLoadBalancersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLoadBalancers([
    'LoadBalancerArns' => ['<string>', ...],
    'Marker' => '<string>',
    'Names' => ['<string>', ...],
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'LoadBalancers' => [
        [
            'AvailabilityZones' => [
                [
                    'LoadBalancerAddresses' => [
                        [
                            'AllocationId' => '<string>',
                            'IPv6Address' => '<string>',
                            'IpAddress' => '<string>',
                            'PrivateIPv4Address' => '<string>',
                        ],
                        // ...
                    ],
                    'OutpostId' => '<string>',
                    'SubnetId' => '<string>',
                    'ZoneName' => '<string>',
                ],
                // ...
            ],
            'CanonicalHostedZoneId' => '<string>',
            'CreatedTime' => <DateTime>,
            'CustomerOwnedIpv4Pool' => '<string>',
            'DNSName' => '<string>',
            'IpAddressType' => 'ipv4|dualstack',
            'LoadBalancerArn' => '<string>',
            'LoadBalancerName' => '<string>',
            'Scheme' => 'internet-facing|internal',
            'SecurityGroups' => ['<string>', ...],
            'State' => [
                'Code' => 'active|provisioning|active_impaired|failed',
                'Reason' => '<string>',
            ],
            'Type' => 'application|network|gateway',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

Examples

Example 1: To describe a load balancer

This example describes the specified load balancer.

$result = $client->describeLoadBalancers([
    'LoadBalancerArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    ],
]);

Result syntax:

[
    'LoadBalancers' => [
        [
            'AvailabilityZones' => [
                [
                    'SubnetId' => 'subnet-8360a9e7',
                    'ZoneName' => 'us-west-2a',
                ],
                [
                    'SubnetId' => 'subnet-b7d581c0',
                    'ZoneName' => 'us-west-2b',
                ],
            ],
            'CanonicalHostedZoneId' => 'Z2P70J7EXAMPLE',
            'CreatedTime' => ,
            'DNSName' => 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'LoadBalancerName' => 'my-load-balancer',
            'Scheme' => 'internet-facing',
            'SecurityGroups' => [
                'sg-5943793c',
            ],
            'State' => [
                'Code' => 'active',
            ],
            'Type' => 'application',
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

DescribeRules

$result = $client->describeRules([/* ... */]);
$promise = $client->describeRulesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeRules([
    'ListenerArn' => '<string>',
    'Marker' => '<string>',
    'PageSize' => <integer>,
    'RuleArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'Rules' => [
        [
            'Actions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'Conditions' => [
                [
                    'Field' => '<string>',
                    'HostHeaderConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'HttpHeaderConfig' => [
                        'HttpHeaderName' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    'HttpRequestMethodConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'PathPatternConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'QueryStringConfig' => [
                        'Values' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SourceIpConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IsDefault' => true || false,
            'Priority' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

• RuleNotFoundException:

  The specified rule does not exist.

• UnsupportedProtocolException:

  The specified protocol is not supported.

Examples

Example 1: To describe a rule

This example describes the specified rule.

$result = $client->describeRules([
    'RuleArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
    ],
]);

Result syntax:

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'Conditions' => [
                [
                    'Field' => 'path-pattern',
                    'Values' => [
                        '/img/*',
                    ],
                ],
            ],
            'IsDefault' => ,
            'Priority' => '10',
            'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
        ],
    ],
]

DescribeSSLPolicies

$result = $client->describeSSLPolicies([/* ... */]);
$promise = $client->describeSSLPoliciesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeSSLPolicies([
    'LoadBalancerType' => 'application|network|gateway',
    'Marker' => '<string>',
    'Names' => ['<string>', ...],
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'SslPolicies' => [
        [
            'Ciphers' => [
                [
                    'Name' => '<string>',
                    'Priority' => <integer>,
                ],
                // ...
            ],
            'Name' => '<string>',
            'SslProtocols' => ['<string>', ...],
            'SupportedLoadBalancerTypes' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

• SSLPolicyNotFoundException:

  The specified SSL policy does not exist.

Examples

Example 1: To describe a policy used for SSL negotiation

This example describes the specified policy used for SSL negotiation.

$result = $client->describeSSLPolicies([
    'Names' => [
        'ELBSecurityPolicy-2015-05',
    ],
]);

Result syntax:

[
    'SslPolicies' => [
        [
            'Ciphers' => [
                [
                    'Name' => 'ECDHE-ECDSA-AES128-GCM-SHA256',
                    'Priority' => 1,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES128-GCM-SHA256',
                    'Priority' => 2,
                ],
                [
                    'Name' => 'ECDHE-ECDSA-AES128-SHA256',
                    'Priority' => 3,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES128-SHA256',
                    'Priority' => 4,
                ],
                [
                    'Name' => 'ECDHE-ECDSA-AES128-SHA',
                    'Priority' => 5,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES128-SHA',
                    'Priority' => 6,
                ],
                [
                    'Name' => 'DHE-RSA-AES128-SHA',
                    'Priority' => 7,
                ],
                [
                    'Name' => 'ECDHE-ECDSA-AES256-GCM-SHA384',
                    'Priority' => 8,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES256-GCM-SHA384',
                    'Priority' => 9,
                ],
                [
                    'Name' => 'ECDHE-ECDSA-AES256-SHA384',
                    'Priority' => 10,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES256-SHA384',
                    'Priority' => 11,
                ],
                [
                    'Name' => 'ECDHE-RSA-AES256-SHA',
                    'Priority' => 12,
                ],
                [
                    'Name' => 'ECDHE-ECDSA-AES256-SHA',
                    'Priority' => 13,
                ],
                [
                    'Name' => 'AES128-GCM-SHA256',
                    'Priority' => 14,
                ],
                [
                    'Name' => 'AES128-SHA256',
                    'Priority' => 15,
                ],
                [
                    'Name' => 'AES128-SHA',
                    'Priority' => 16,
                ],
                [
                    'Name' => 'AES256-GCM-SHA384',
                    'Priority' => 17,
                ],
                [
                    'Name' => 'AES256-SHA256',
                    'Priority' => 18,
                ],
                [
                    'Name' => 'AES256-SHA',
                    'Priority' => 19,
                ],
            ],
            'Name' => 'ELBSecurityPolicy-2015-05',
            'SslProtocols' => [
                'TLSv1',
                'TLSv1.1',
                'TLSv1.2',
            ],
        ],
    ],
]

DescribeTags

$result = $client->describeTags([/* ... */]);
$promise = $client->describeTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTags([
    'ResourceArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagDescriptions' => [
        [
            'ResourceArn' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• ListenerNotFoundException:

  The specified listener does not exist.

• RuleNotFoundException:

  The specified rule does not exist.

Examples

Example 1: To describe the tags assigned to a load balancer

This example describes the tags assigned to the specified load balancer.

$result = $client->describeTags([
    'ResourceArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    ],
]);

Result syntax:

[
    'TagDescriptions' => [
        [
            'ResourceArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Tags' => [
                [
                    'Key' => 'project',
                    'Value' => 'lima',
                ],
                [
                    'Key' => 'department',
                    'Value' => 'digital-media',
                ],
            ],
        ],
    ],
]

DescribeTargetGroupAttributes

$result = $client->describeTargetGroupAttributes([/* ... */]);
$promise = $client->describeTargetGroupAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTargetGroupAttributes([
    'TargetGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• TargetGroupNotFoundException:

  The specified target group does not exist.

Examples

Example 1: To describe target group attributes

This example describes the attributes of the specified target group.

$result = $client->describeTargetGroupAttributes([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'stickiness.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'deregistration_delay.timeout_seconds',
            'Value' => '300',
        ],
        [
            'Key' => 'stickiness.type',
            'Value' => 'lb_cookie',
        ],
        [
            'Key' => 'stickiness.lb_cookie.duration_seconds',
            'Value' => '86400',
        ],
    ],
]

DescribeTargetGroups

$result = $client->describeTargetGroups([/* ... */]);
$promise = $client->describeTargetGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTargetGroups([
    'LoadBalancerArn' => '<string>',
    'Marker' => '<string>',
    'Names' => ['<string>', ...],
    'PageSize' => <integer>,
    'TargetGroupArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextMarker' => '<string>',
    'TargetGroups' => [
        [
            'HealthCheckEnabled' => true || false,
            'HealthCheckIntervalSeconds' => <integer>,
            'HealthCheckPath' => '<string>',
            'HealthCheckPort' => '<string>',
            'HealthCheckProtocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'HealthCheckTimeoutSeconds' => <integer>,
            'HealthyThresholdCount' => <integer>,
            'IpAddressType' => 'ipv4|ipv6',
            'LoadBalancerArns' => ['<string>', ...],
            'Matcher' => [
                'GrpcCode' => '<string>',
                'HttpCode' => '<string>',
            ],
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'ProtocolVersion' => '<string>',
            'TargetGroupArn' => '<string>',
            'TargetGroupName' => '<string>',
            'TargetType' => 'instance|ip|lambda|alb',
            'UnhealthyThresholdCount' => <integer>,
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

Examples

Example 1: To describe a target group

This example describes the specified target group.

$result = $client->describeTargetGroups([
    'TargetGroupArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
]);

Result syntax:

[
    'TargetGroups' => [
        [
            'HealthCheckIntervalSeconds' => 30,
            'HealthCheckPath' => '/',
            'HealthCheckPort' => 'traffic-port',
            'HealthCheckProtocol' => 'HTTP',
            'HealthCheckTimeoutSeconds' => 5,
            'HealthyThresholdCount' => 5,
            'LoadBalancerArns' => [
                'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            ],
            'Matcher' => [
                'HttpCode' => '200',
            ],
            'Port' => 80,
            'Protocol' => 'HTTP',
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'TargetGroupName' => 'my-targets',
            'UnhealthyThresholdCount' => 2,
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

DescribeTargetHealth

$result = $client->describeTargetHealth([/* ... */]);
$promise = $client->describeTargetHealthAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTargetHealth([
    'TargetGroupArn' => '<string>', // REQUIRED
    'Targets' => [
        [
            'AvailabilityZone' => '<string>',
            'Id' => '<string>', // REQUIRED
            'Port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'TargetHealthDescriptions' => [
        [
            'HealthCheckPort' => '<string>',
            'Target' => [
                'AvailabilityZone' => '<string>',
                'Id' => '<string>',
                'Port' => <integer>,
            ],
            'TargetHealth' => [
                'Description' => '<string>',
                'Reason' => 'Elb.RegistrationInProgress|Elb.InitialHealthChecking|Target.ResponseCodeMismatch|Target.Timeout|Target.FailedHealthChecks|Target.NotRegistered|Target.NotInUse|Target.DeregistrationInProgress|Target.InvalidState|Target.IpUnusable|Target.HealthCheckDisabled|Elb.InternalError',
                'State' => 'initial|healthy|unhealthy|unused|draining|unavailable',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidTargetException:

  The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• HealthUnavailableException:

  The health of the specified targets could not be retrieved due to an internal error.

Examples

Example 1: To describe the health of the targets for a target group

This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.

$result = $client->describeTargetHealth([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
]);

Result syntax:

[
    'TargetHealthDescriptions' => [
        [
            'Target' => [
                'Id' => 'i-0f76fade',
                'Port' => 80,
            ],
            'TargetHealth' => [
                'Description' => 'Given target group is not configured to receive traffic from ELB',
                'Reason' => 'Target.NotInUse',
                'State' => 'unused',
            ],
        ],
        [
            'HealthCheckPort' => '80',
            'Target' => [
                'Id' => 'i-0f76fade',
                'Port' => 80,
            ],
            'TargetHealth' => [
                'State' => 'healthy',
            ],
        ],
    ],
]

Example 2: To describe the health of a target

This example describes the health of the specified target. This target is healthy.

$result = $client->describeTargetHealth([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    'Targets' => [
        [
            'Id' => 'i-0f76fade',
            'Port' => 80,
        ],
    ],
]);

Result syntax:

[
    'TargetHealthDescriptions' => [
        [
            'HealthCheckPort' => '80',
            'Target' => [
                'Id' => 'i-0f76fade',
                'Port' => 80,
            ],
            'TargetHealth' => [
                'State' => 'healthy',
            ],
        ],
    ],
]

ModifyListener

$result = $client->modifyListener([/* ... */]);
$promise = $client->modifyListenerAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyListener([
    'AlpnPolicy' => ['<string>', ...],
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
    'DefaultActions' => [
        [
            'AuthenticateCognitoConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'UserPoolArn' => '<string>', // REQUIRED
                'UserPoolClientId' => '<string>', // REQUIRED
                'UserPoolDomain' => '<string>', // REQUIRED
            ],
            'AuthenticateOidcConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'AuthorizationEndpoint' => '<string>', // REQUIRED
                'ClientId' => '<string>', // REQUIRED
                'ClientSecret' => '<string>',
                'Issuer' => '<string>', // REQUIRED
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'TokenEndpoint' => '<string>', // REQUIRED
                'UseExistingClientSecret' => true || false,
                'UserInfoEndpoint' => '<string>', // REQUIRED
            ],
            'FixedResponseConfig' => [
                'ContentType' => '<string>',
                'MessageBody' => '<string>',
                'StatusCode' => '<string>', // REQUIRED
            ],
            'ForwardConfig' => [
                'TargetGroupStickinessConfig' => [
                    'DurationSeconds' => <integer>,
                    'Enabled' => true || false,
                ],
                'TargetGroups' => [
                    [
                        'TargetGroupArn' => '<string>',
                        'Weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'Order' => <integer>,
            'RedirectConfig' => [
                'Host' => '<string>',
                'Path' => '<string>',
                'Port' => '<string>',
                'Protocol' => '<string>',
                'Query' => '<string>',
                'StatusCode' => 'HTTP_301|HTTP_302', // REQUIRED
            ],
            'TargetGroupArn' => '<string>',
            'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response', // REQUIRED
        ],
        // ...
    ],
    'ListenerArn' => '<string>', // REQUIRED
    'Port' => <integer>,
    'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
    'SslPolicy' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Listeners' => [
        [
            'AlpnPolicy' => ['<string>', ...],
            'Certificates' => [
                [
                    'CertificateArn' => '<string>',
                    'IsDefault' => true || false,
                ],
                // ...
            ],
            'DefaultActions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'ListenerArn' => '<string>',
            'LoadBalancerArn' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'SslPolicy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• DuplicateListenerException:

  A listener with the specified port already exists.

• TooManyListenersException:

  You've reached the limit on the number of listeners per load balancer.

• TooManyCertificatesException:

  You've reached the limit on the number of certificates per load balancer.

• ListenerNotFoundException:

  The specified listener does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• TargetGroupAssociationLimitException:

  You've reached the limit on the number of load balancers per target group.

• IncompatibleProtocolsException:

  The specified configuration is not valid with this protocol.

• SSLPolicyNotFoundException:

  The specified SSL policy does not exist.

• CertificateNotFoundException:

  The specified certificate does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• UnsupportedProtocolException:

  The specified protocol is not supported.

• TooManyRegistrationsForTargetIdException:

  You've reached the limit on the number of times a target can be registered with a load balancer.

• TooManyTargetsException:

  You've reached the limit on the number of targets.

• TooManyActionsException:

  You've reached the limit on the number of actions per rule.

• InvalidLoadBalancerActionException:

  The requested action is not valid.

• TooManyUniqueTargetGroupsPerLoadBalancerException:

  You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

• ALPNPolicyNotSupportedException:

  The specified ALPN policy is not supported.

Examples

Example 1: To change the default action for a listener

This example changes the default action for the specified listener.

$result = $client->modifyListener([
    'DefaultActions' => [
        [
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f',
            'Type' => 'forward',
        ],
    ],
    'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
]);

Result syntax:

[
    'Listeners' => [
        [
            'DefaultActions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f',
                    'Type' => 'forward',
                ],
            ],
            'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Port' => 80,
            'Protocol' => 'HTTP',
        ],
    ],
]

Example 2: To change the server certificate

This example changes the server certificate for the specified HTTPS listener.

$result = $client->modifyListener([
    'Certificates' => [
        [
            'CertificateArn' => 'arn:aws:iam::123456789012:server-certificate/my-new-server-cert',
        ],
    ],
    'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65',
]);

Result syntax:

[
    'Listeners' => [
        [
            'Certificates' => [
                [
                    'CertificateArn' => 'arn:aws:iam::123456789012:server-certificate/my-new-server-cert',
                ],
            ],
            'DefaultActions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'ListenerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65',
            'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'Port' => 443,
            'Protocol' => 'HTTPS',
            'SslPolicy' => 'ELBSecurityPolicy-2015-05',
        ],
    ],
]

ModifyLoadBalancerAttributes

$result = $client->modifyLoadBalancerAttributes([/* ... */]);
$promise = $client->modifyLoadBalancerAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyLoadBalancerAttributes([
    'Attributes' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'LoadBalancerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

Examples

Example 1: To enable deletion protection

This example enables deletion protection for the specified load balancer.

$result = $client->modifyLoadBalancerAttributes([
    'Attributes' => [
        [
            'Key' => 'deletion_protection.enabled',
            'Value' => 'true',
        ],
    ],
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'deletion_protection.enabled',
            'Value' => 'true',
        ],
        [
            'Key' => 'access_logs.s3.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'idle_timeout.timeout_seconds',
            'Value' => '60',
        ],
        [
            'Key' => 'access_logs.s3.prefix',
            'Value' => '',
        ],
        [
            'Key' => 'access_logs.s3.bucket',
            'Value' => '',
        ],
    ],
]

Example 2: To change the idle timeout

This example changes the idle timeout value for the specified load balancer.

$result = $client->modifyLoadBalancerAttributes([
    'Attributes' => [
        [
            'Key' => 'idle_timeout.timeout_seconds',
            'Value' => '30',
        ],
    ],
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'idle_timeout.timeout_seconds',
            'Value' => '30',
        ],
        [
            'Key' => 'access_logs.s3.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'access_logs.s3.prefix',
            'Value' => '',
        ],
        [
            'Key' => 'deletion_protection.enabled',
            'Value' => 'true',
        ],
        [
            'Key' => 'access_logs.s3.bucket',
            'Value' => '',
        ],
    ],
]

Example 3: To enable access logs

This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.

$result = $client->modifyLoadBalancerAttributes([
    'Attributes' => [
        [
            'Key' => 'access_logs.s3.enabled',
            'Value' => 'true',
        ],
        [
            'Key' => 'access_logs.s3.bucket',
            'Value' => 'my-loadbalancer-logs',
        ],
        [
            'Key' => 'access_logs.s3.prefix',
            'Value' => 'myapp',
        ],
    ],
    'LoadBalancerArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'access_logs.s3.enabled',
            'Value' => 'true',
        ],
        [
            'Key' => 'access_logs.s3.bucket',
            'Value' => 'my-load-balancer-logs',
        ],
        [
            'Key' => 'access_logs.s3.prefix',
            'Value' => 'myapp',
        ],
        [
            'Key' => 'idle_timeout.timeout_seconds',
            'Value' => '60',
        ],
        [
            'Key' => 'deletion_protection.enabled',
            'Value' => 'false',
        ],
    ],
]

ModifyRule

$result = $client->modifyRule([/* ... */]);
$promise = $client->modifyRuleAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyRule([
    'Actions' => [
        [
            'AuthenticateCognitoConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'UserPoolArn' => '<string>', // REQUIRED
                'UserPoolClientId' => '<string>', // REQUIRED
                'UserPoolDomain' => '<string>', // REQUIRED
            ],
            'AuthenticateOidcConfig' => [
                'AuthenticationRequestExtraParams' => ['<string>', ...],
                'AuthorizationEndpoint' => '<string>', // REQUIRED
                'ClientId' => '<string>', // REQUIRED
                'ClientSecret' => '<string>',
                'Issuer' => '<string>', // REQUIRED
                'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                'Scope' => '<string>',
                'SessionCookieName' => '<string>',
                'SessionTimeout' => <integer>,
                'TokenEndpoint' => '<string>', // REQUIRED
                'UseExistingClientSecret' => true || false,
                'UserInfoEndpoint' => '<string>', // REQUIRED
            ],
            'FixedResponseConfig' => [
                'ContentType' => '<string>',
                'MessageBody' => '<string>',
                'StatusCode' => '<string>', // REQUIRED
            ],
            'ForwardConfig' => [
                'TargetGroupStickinessConfig' => [
                    'DurationSeconds' => <integer>,
                    'Enabled' => true || false,
                ],
                'TargetGroups' => [
                    [
                        'TargetGroupArn' => '<string>',
                        'Weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'Order' => <integer>,
            'RedirectConfig' => [
                'Host' => '<string>',
                'Path' => '<string>',
                'Port' => '<string>',
                'Protocol' => '<string>',
                'Query' => '<string>',
                'StatusCode' => 'HTTP_301|HTTP_302', // REQUIRED
            ],
            'TargetGroupArn' => '<string>',
            'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response', // REQUIRED
        ],
        // ...
    ],
    'Conditions' => [
        [
            'Field' => '<string>',
            'HostHeaderConfig' => [
                'Values' => ['<string>', ...],
            ],
            'HttpHeaderConfig' => [
                'HttpHeaderName' => '<string>',
                'Values' => ['<string>', ...],
            ],
            'HttpRequestMethodConfig' => [
                'Values' => ['<string>', ...],
            ],
            'PathPatternConfig' => [
                'Values' => ['<string>', ...],
            ],
            'QueryStringConfig' => [
                'Values' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'SourceIpConfig' => [
                'Values' => ['<string>', ...],
            ],
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'RuleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'Conditions' => [
                [
                    'Field' => '<string>',
                    'HostHeaderConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'HttpHeaderConfig' => [
                        'HttpHeaderName' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    'HttpRequestMethodConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'PathPatternConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'QueryStringConfig' => [
                        'Values' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SourceIpConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IsDefault' => true || false,
            'Priority' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• TargetGroupAssociationLimitException:

  You've reached the limit on the number of load balancers per target group.

• IncompatibleProtocolsException:

  The specified configuration is not valid with this protocol.

• RuleNotFoundException:

  The specified rule does not exist.

• OperationNotPermittedException:

  This operation is not allowed.

• TooManyRegistrationsForTargetIdException:

  You've reached the limit on the number of times a target can be registered with a load balancer.

• TooManyTargetsException:

  You've reached the limit on the number of targets.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• UnsupportedProtocolException:

  The specified protocol is not supported.

• TooManyActionsException:

  You've reached the limit on the number of actions per rule.

• InvalidLoadBalancerActionException:

  The requested action is not valid.

• TooManyUniqueTargetGroupsPerLoadBalancerException:

  You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.

Examples

Example 1: To modify a rule

This example modifies the condition for the specified rule.

$result = $client->modifyRule([
    'Conditions' => [
        [
            'Field' => 'path-pattern',
            'Values' => [
                '/images/*',
            ],
        ],
    ],
    'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
]);

Result syntax:

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'Conditions' => [
                [
                    'Field' => 'path-pattern',
                    'Values' => [
                        '/images/*',
                    ],
                ],
            ],
            'IsDefault' => ,
            'Priority' => '10',
            'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
        ],
    ],
]

ModifyTargetGroup

$result = $client->modifyTargetGroup([/* ... */]);
$promise = $client->modifyTargetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyTargetGroup([
    'HealthCheckEnabled' => true || false,
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => '<string>',
    'HealthCheckProtocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
    'HealthCheckTimeoutSeconds' => <integer>,
    'HealthyThresholdCount' => <integer>,
    'Matcher' => [
        'GrpcCode' => '<string>',
        'HttpCode' => '<string>',
    ],
    'TargetGroupArn' => '<string>', // REQUIRED
    'UnhealthyThresholdCount' => <integer>,
]);

Parameter Details

Result Syntax

[
    'TargetGroups' => [
        [
            'HealthCheckEnabled' => true || false,
            'HealthCheckIntervalSeconds' => <integer>,
            'HealthCheckPath' => '<string>',
            'HealthCheckPort' => '<string>',
            'HealthCheckProtocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'HealthCheckTimeoutSeconds' => <integer>,
            'HealthyThresholdCount' => <integer>,
            'IpAddressType' => 'ipv4|ipv6',
            'LoadBalancerArns' => ['<string>', ...],
            'Matcher' => [
                'GrpcCode' => '<string>',
                'HttpCode' => '<string>',
            ],
            'Port' => <integer>,
            'Protocol' => 'HTTP|HTTPS|TCP|TLS|UDP|TCP_UDP|GENEVE',
            'ProtocolVersion' => '<string>',
            'TargetGroupArn' => '<string>',
            'TargetGroupName' => '<string>',
            'TargetType' => 'instance|ip|lambda|alb',
            'UnhealthyThresholdCount' => <integer>,
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• TargetGroupNotFoundException:

  The specified target group does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

Examples

Example 1: To modify the health check configuration for a target group

This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.

$result = $client->modifyTargetGroup([
    'HealthCheckPort' => '443',
    'HealthCheckProtocol' => 'HTTPS',
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
]);

Result syntax:

[
    'TargetGroups' => [
        [
            'HealthCheckIntervalSeconds' => 30,
            'HealthCheckPort' => '443',
            'HealthCheckProtocol' => 'HTTPS',
            'HealthCheckTimeoutSeconds' => 5,
            'HealthyThresholdCount' => 5,
            'LoadBalancerArns' => [
                'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            ],
            'Matcher' => [
                'HttpCode' => '200',
            ],
            'Port' => 443,
            'Protocol' => 'HTTPS',
            'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
            'TargetGroupName' => 'my-https-targets',
            'UnhealthyThresholdCount' => 2,
            'VpcId' => 'vpc-3ac0fb5f',
        ],
    ],
]

ModifyTargetGroupAttributes

$result = $client->modifyTargetGroupAttributes([/* ... */]);
$promise = $client->modifyTargetGroupAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyTargetGroupAttributes([
    'Attributes' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• TargetGroupNotFoundException:

  The specified target group does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

Examples

Example 1: To modify the deregistration delay timeout

This example sets the deregistration delay timeout to the specified value for the specified target group.

$result = $client->modifyTargetGroupAttributes([
    'Attributes' => [
        [
            'Key' => 'deregistration_delay.timeout_seconds',
            'Value' => '600',
        ],
    ],
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
]);

Result syntax:

[
    'Attributes' => [
        [
            'Key' => 'stickiness.enabled',
            'Value' => 'false',
        ],
        [
            'Key' => 'deregistration_delay.timeout_seconds',
            'Value' => '600',
        ],
        [
            'Key' => 'stickiness.type',
            'Value' => 'lb_cookie',
        ],
        [
            'Key' => 'stickiness.lb_cookie.duration_seconds',
            'Value' => '86400',
        ],
    ],
]

RegisterTargets

$result = $client->registerTargets([/* ... */]);
$promise = $client->registerTargetsAsync([/* ... */]);

Parameter Syntax

$result = $client->registerTargets([
    'TargetGroupArn' => '<string>', // REQUIRED
    'Targets' => [ // REQUIRED
        [
            'AvailabilityZone' => '<string>',
            'Id' => '<string>', // REQUIRED
            'Port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• TargetGroupNotFoundException:

  The specified target group does not exist.

• TooManyTargetsException:

  You've reached the limit on the number of targets.

• InvalidTargetException:

  The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

• TooManyRegistrationsForTargetIdException:

  You've reached the limit on the number of times a target can be registered with a load balancer.

Examples

Example 1: To register targets with a target group

This example registers the specified instances with the specified target group.

$result = $client->registerTargets([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    'Targets' => [
        [
            'Id' => 'i-80c8dd94',
        ],
        [
            'Id' => 'i-ceddcd4d',
        ],
    ],
]);

Example 2: To register targets with a target group using port overrides

This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.

$result = $client->registerTargets([
    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9',
    'Targets' => [
        [
            'Id' => 'i-80c8dd94',
            'Port' => 80,
        ],
        [
            'Id' => 'i-80c8dd94',
            'Port' => 766,
        ],
    ],
]);

RemoveListenerCertificates

$result = $client->removeListenerCertificates([/* ... */]);
$promise = $client->removeListenerCertificatesAsync([/* ... */]);

Parameter Syntax

$result = $client->removeListenerCertificates([
    'Certificates' => [ // REQUIRED
        [
            'CertificateArn' => '<string>',
            'IsDefault' => true || false,
        ],
        // ...
    ],
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ListenerNotFoundException:

  The specified listener does not exist.

• OperationNotPermittedException:

  This operation is not allowed.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->removeTags([
    'ResourceArns' => ['<string>', ...], // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• TargetGroupNotFoundException:

  The specified target group does not exist.

• ListenerNotFoundException:

  The specified listener does not exist.

• RuleNotFoundException:

  The specified rule does not exist.

• TooManyTagsException:

  You've reached the limit on the number of tags per load balancer.

Examples

Example 1: To remove tags from a load balancer

This example removes the specified tags from the specified load balancer.

$result = $client->removeTags([
    'ResourceArns' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    ],
    'TagKeys' => [
        'project',
        'department',
    ],
]);

SetIpAddressType

$result = $client->setIpAddressType([/* ... */]);
$promise = $client->setIpAddressTypeAsync([/* ... */]);

Parameter Syntax

$result = $client->setIpAddressType([
    'IpAddressType' => 'ipv4|dualstack', // REQUIRED
    'LoadBalancerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IpAddressType' => 'ipv4|dualstack',
]

Result Details

Errors

• LoadBalancerNotFoundException:

  The specified load balancer does not exist.

• InvalidConfigurationRequestException:

  The requested configuration is not valid.

• InvalidSubnetException:

  The specified subnet is out of available addresses.

SetRulePriorities

$result = $client->setRulePriorities([/* ... */]);
$promise = $client->setRulePrioritiesAsync([/* ... */]);

Parameter Syntax

$result = $client->setRulePriorities([
    'RulePriorities' => [ // REQUIRED
        [
            'Priority' => <integer>,
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'AuthenticateCognitoConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'UserPoolArn' => '<string>',
                        'UserPoolClientId' => '<string>',
                        'UserPoolDomain' => '<string>',
                    ],
                    'AuthenticateOidcConfig' => [
                        'AuthenticationRequestExtraParams' => ['<string>', ...],
                        'AuthorizationEndpoint' => '<string>',
                        'ClientId' => '<string>',
                        'ClientSecret' => '<string>',
                        'Issuer' => '<string>',
                        'OnUnauthenticatedRequest' => 'deny|allow|authenticate',
                        'Scope' => '<string>',
                        'SessionCookieName' => '<string>',
                        'SessionTimeout' => <integer>,
                        'TokenEndpoint' => '<string>',
                        'UseExistingClientSecret' => true || false,
                        'UserInfoEndpoint' => '<string>',
                    ],
                    'FixedResponseConfig' => [
                        'ContentType' => '<string>',
                        'MessageBody' => '<string>',
                        'StatusCode' => '<string>',
                    ],
                    'ForwardConfig' => [
                        'TargetGroupStickinessConfig' => [
                            'DurationSeconds' => <integer>,
                            'Enabled' => true || false,
                        ],
                        'TargetGroups' => [
                            [
                                'TargetGroupArn' => '<string>',
                                'Weight' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                    'Order' => <integer>,
                    'RedirectConfig' => [
                        'Host' => '<string>',
                        'Path' => '<string>',
                        'Port' => '<string>',
                        'Protocol' => '<string>',
                        'Query' => '<string>',
                        'StatusCode' => 'HTTP_301|HTTP_302',
                    ],
                    'TargetGroupArn' => '<string>',
                    'Type' => 'forward|authenticate-oidc|authenticate-cognito|redirect|fixed-response',
                ],
                // ...
            ],
            'Conditions' => [
                [
                    'Field' => '<string>',
                    'HostHeaderConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'HttpHeaderConfig' => [
                        'HttpHeaderName' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    'HttpRequestMethodConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'PathPatternConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'QueryStringConfig' => [
                        'Values' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SourceIpConfig' => [
                        'Values' => ['<string>', ...],
                    ],
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
            'IsDefault' => true || false,
            'Priority' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• RuleNotFoundException:

  The specified rule does not exist.

• PriorityInUseException:

  The specified priority is in use.

• OperationNotPermittedException:

  This operation is not allowed.

Examples

Example 1: To set the rule priority

This example sets the priority of the specified rule.

$result = $client->setRulePriorities([
    'RulePriorities' => [
        [
            'Priority' => 5,
            'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
        ],
    ],
]);

Result syntax:

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'TargetGroupArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
                    'Type' => 'forward',
                ],
            ],
            'Conditions' => [
                [
                    'Field' => 'path-pattern',
                    'Values' => [
                        '/img/*',
                    ],
                ],
            ],
            'IsDefault' => ,
            'Priority' => '5',
            'RuleArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
        ],
    ],
]

SetSecurityGroups

$result = $client->setSecurityGroups([/* ... */]);
$promise = $client->setSecurityGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->setSecurityGroups([
    'LoadBalancerArn' => '<string>', // REQUIRED
    'SecurityGroups' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SecurityGroupIds' => ['<string>', ...],
]

Result Details

Errors