AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Elastic Load Balancing ModifyLoadBalancerAttributes API operation.

Syntax

Edit-ELBLoadBalancerAttribute
-LoadBalancerName <String>
-LoadBalancerAttributes_AdditionalAttribute <AdditionalAttribute[]>
-AccessLog_EmitInterval <Int32>
-AccessLog_Enabled <Boolean>
-ConnectionDraining_Enabled <Boolean>
-CrossZoneLoadBalancing_Enabled <Boolean>
-ConnectionSettings_IdleTimeout <Int32>
-AccessLog_S3BucketName <String>
-AccessLog_S3BucketPrefix <String>
-ConnectionDraining_Timeout <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Modifies the attributes of the specified load balancer. You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer. For more information, see the following in the Classic Load Balancers Guide:

Parameters

-AccessLog_EmitInterval <Int32>
The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.Default: 60 minutes
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_AccessLog_EmitInterval
-AccessLog_Enabled <Boolean>
Specifies whether access logs are enabled for the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_AccessLog_Enabled
-AccessLog_S3BucketName <String>
The name of the Amazon S3 bucket where the access logs are stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_AccessLog_S3BucketName
-AccessLog_S3BucketPrefix <String>
The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_AccessLog_S3BucketPrefix
-ConnectionDraining_Enabled <Boolean>
Specifies whether connection draining is enabled for the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_ConnectionDraining_Enabled
-ConnectionDraining_Timeout <Int32>
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_ConnectionDraining_Timeout
-ConnectionSettings_IdleTimeout <Int32>
The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_ConnectionSettings_IdleTimeout
-CrossZoneLoadBalancing_Enabled <Boolean>
Specifies whether cross-zone load balancing is enabled for the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_CrossZoneLoadBalancing_Enabled
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerAttributes_AdditionalAttribute <AdditionalAttribute[]>
This parameter is reserved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerAttributes_AdditionalAttributes
-LoadBalancerName <String>
The name of the load balancer.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the LoadBalancerName parameter. The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResponse). Specifying the name of a property of type Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -CrossZoneLoadBalancing_Enabled $true
This example enables cross-zone load balancing for the specified load balancer.

Example 2

PS C:\> Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -ConnectionDraining_Enabled $false
This example disables connection draining for the specified load balancer.

Example 3

PS C:\> Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer `
>> -AccessLog_Enabled $true `
>> -AccessLog_S3BucketName my-logs-bucket `
>> -AccessLog_S3BucketPrefix my-app/prod `
>> -AccessLog_EmitInterval 60
This example enables access logging for the specified load balancer.

Supported Version

AWS Tools for PowerShell: 2.x.y.z