SetSecurityGroups - Elastic Load Balancing

SetSecurityGroups

Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.

You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.

You can't associate a security group with a Gateway Load Balancer.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink. The default is on.

Type: String

Valid Values: on | off

Required: No

LoadBalancerArn

The Amazon Resource Name (ARN) of the load balancer.

Type: String

Required: Yes

SecurityGroups.member.N

The IDs of the security groups.

Type: Array of strings

Required: Yes

Response Elements

The following elements are returned by the service.

EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.

Type: String

Valid Values: on | off

SecurityGroupIds.member.N

The IDs of the security groups associated with the load balancer.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidConfigurationRequest

The requested configuration is not valid.

HTTP Status Code: 400

InvalidSecurityGroup

The specified security group does not exist.

HTTP Status Code: 400

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400

Examples

Associate a security group with a load balancer

This example associates the specified security group with the specified load balancer.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=SetSecurityGroups &LoadBalancerArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 &SecurityGroups.member.1=sg-5943793c &Version=2015-12-01 &AUTHPARAMS

Sample Response

<SetSecurityGroupsResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/"> <SetSecurityGroupsResult> <SecurityGroupIds> <member>sg-5943793c</member> </SecurityGroupIds> </SetSecurityGroupsResult> <ResponseMetadata> <RequestId>a127426b-f3ab-11e5-9192-3fff33344cfa</RequestId> </ResponseMetadata> </SetSecurityGroupsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: