Bicep resource definition
The elasticLoadBalancingV2LoadBalancers resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
canonicalHostedZoneID: 'string'
dnsName: 'string'
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: 'string'
ipAddressType: 'string'
loadBalancerArn: 'string'
loadBalancerAttributes: [
{
key: 'string'
value: 'string'
}
]
loadBalancerFullName: 'string'
loadBalancerName: 'string'
name: 'string'
scheme: 'string'
securityGroups: [
'string'
]
subnetMappings: [
{
allocationId: 'string'
iPv6Address: 'string'
privateIPv4Address: 'string'
subnetId: 'string'
}
]
subnets: [
'string'
]
tags: [
{
key: 'string'
value: 'string'
}
]
type: 'string'
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
ElasticLoadBalancingV2LoadBalancerProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AwsElasticLoadBalancingV2LoadBalancerProperties
| Name |
Description |
Value |
| canonicalHostedZoneID |
Property canonicalHostedZoneID |
string |
| dnsName |
Property dnsName |
string |
| enforceSecurityGroupInboundRulesOnPrivateLinkTraffic |
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. |
string |
| ipAddressType |
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. |
string |
| loadBalancerArn |
Property loadBalancerArn |
string |
| loadBalancerAttributes |
The load balancer attributes. |
LoadBalancerAttribute[] |
| loadBalancerFullName |
Property loadBalancerFullName |
string |
| loadBalancerName |
Property loadBalancerName |
string |
| name |
The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. |
string |
| scheme |
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. |
string |
| securityGroups |
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
string[] |
| subnetMappings |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. |
SubnetMapping[] |
| subnets |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
string[] |
| tags |
The tags to assign to the load balancer. |
TagAutoGenerated29[] |
| type |
The type of load balancer. The default is application. |
string |
ElasticLoadBalancingV2LoadBalancerProperties
LoadBalancerAttribute
| Name |
Description |
Value |
| key |
The name of the attribute. The following attributes are supported by all load balancers: + deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. + load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. + access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. + ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false. + connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs. + routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive. + routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false. + routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false. + routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false. + routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false. + routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append. + If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets. + If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change. + If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets. + routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false. The following attributes are supported by only Network Load Balancers: + dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity. |
string |
| value |
The value of the attribute. |
string |
SubnetMapping
| Name |
Description |
Value |
| allocationId |
[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. |
string |
| iPv6Address |
[Network Load Balancers] The IPv6 address. |
string |
| privateIPv4Address |
[Network Load Balancers] The private IPv4 address for an internal load balancer. |
string |
| subnetId |
The ID of the subnet. |
string |
TagAutoGenerated29
| Name |
Description |
Value |
| key |
The key of the tag. |
string |
| value |
The value of the tag. |
string |
ARM template resource definition
The elasticLoadBalancingV2LoadBalancers resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"canonicalHostedZoneID": "string",
"dnsName": "string",
"enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "string",
"ipAddressType": "string",
"loadBalancerArn": "string",
"loadBalancerAttributes": [
{
"key": "string",
"value": "string"
}
],
"loadBalancerFullName": "string",
"loadBalancerName": "string",
"name": "string",
"scheme": "string",
"securityGroups": [ "string" ],
"subnetMappings": [
{
"allocationId": "string",
"iPv6Address": "string",
"privateIPv4Address": "string",
"subnetId": "string"
}
],
"subnets": [ "string" ],
"tags": [
{
"key": "string",
"value": "string"
}
],
"type": "string"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers
| Name |
Description |
Value |
| apiVersion |
The api version |
'2024-12-01' |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
ElasticLoadBalancingV2LoadBalancerProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers' |
AwsElasticLoadBalancingV2LoadBalancerProperties
| Name |
Description |
Value |
| canonicalHostedZoneID |
Property canonicalHostedZoneID |
string |
| dnsName |
Property dnsName |
string |
| enforceSecurityGroupInboundRulesOnPrivateLinkTraffic |
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. |
string |
| ipAddressType |
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. |
string |
| loadBalancerArn |
Property loadBalancerArn |
string |
| loadBalancerAttributes |
The load balancer attributes. |
LoadBalancerAttribute[] |
| loadBalancerFullName |
Property loadBalancerFullName |
string |
| loadBalancerName |
Property loadBalancerName |
string |
| name |
The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. |
string |
| scheme |
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. |
string |
| securityGroups |
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
string[] |
| subnetMappings |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. |
SubnetMapping[] |
| subnets |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
string[] |
| tags |
The tags to assign to the load balancer. |
TagAutoGenerated29[] |
| type |
The type of load balancer. The default is application. |
string |
ElasticLoadBalancingV2LoadBalancerProperties
LoadBalancerAttribute
| Name |
Description |
Value |
| key |
The name of the attribute. The following attributes are supported by all load balancers: + deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. + load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. + access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. + ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false. + connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs. + routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive. + routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false. + routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false. + routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false. + routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false. + routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append. + If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets. + If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change. + If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets. + routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false. The following attributes are supported by only Network Load Balancers: + dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity. |
string |
| value |
The value of the attribute. |
string |
SubnetMapping
| Name |
Description |
Value |
| allocationId |
[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. |
string |
| iPv6Address |
[Network Load Balancers] The IPv6 address. |
string |
| privateIPv4Address |
[Network Load Balancers] The private IPv4 address for an internal load balancer. |
string |
| subnetId |
The ID of the subnet. |
string |
TagAutoGenerated29
| Name |
Description |
Value |
| key |
The key of the tag. |
string |
| value |
The value of the tag. |
string |
Usage Examples
The elasticLoadBalancingV2LoadBalancers resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
canonicalHostedZoneID = "string"
dnsName = "string"
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic = "string"
ipAddressType = "string"
loadBalancerArn = "string"
loadBalancerAttributes = [
{
key = "string"
value = "string"
}
]
loadBalancerFullName = "string"
loadBalancerName = "string"
name = "string"
scheme = "string"
securityGroups = [
"string"
]
subnetMappings = [
{
allocationId = "string"
iPv6Address = "string"
privateIPv4Address = "string"
subnetId = "string"
}
]
subnets = [
"string"
]
tags = [
{
key = "string"
value = "string"
}
]
type = "string"
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
ElasticLoadBalancingV2LoadBalancerProperties |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers@2024-12-01" |
AwsElasticLoadBalancingV2LoadBalancerProperties
| Name |
Description |
Value |
| canonicalHostedZoneID |
Property canonicalHostedZoneID |
string |
| dnsName |
Property dnsName |
string |
| enforceSecurityGroupInboundRulesOnPrivateLinkTraffic |
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. |
string |
| ipAddressType |
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. |
string |
| loadBalancerArn |
Property loadBalancerArn |
string |
| loadBalancerAttributes |
The load balancer attributes. |
LoadBalancerAttribute[] |
| loadBalancerFullName |
Property loadBalancerFullName |
string |
| loadBalancerName |
Property loadBalancerName |
string |
| name |
The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. |
string |
| scheme |
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. |
string |
| securityGroups |
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
string[] |
| subnetMappings |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. |
SubnetMapping[] |
| subnets |
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. |
string[] |
| tags |
The tags to assign to the load balancer. |
TagAutoGenerated29[] |
| type |
The type of load balancer. The default is application. |
string |
ElasticLoadBalancingV2LoadBalancerProperties
LoadBalancerAttribute
| Name |
Description |
Value |
| key |
The name of the attribute. The following attributes are supported by all load balancers: + deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. + load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. + access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. + ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false. + connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs. + routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive. + routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false. + routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false. + routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false. + routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false. + routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append. + If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets. + If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change. + If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets. + routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false. The following attributes are supported by only Network Load Balancers: + dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity. |
string |
| value |
The value of the attribute. |
string |
SubnetMapping
| Name |
Description |
Value |
| allocationId |
[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. |
string |
| iPv6Address |
[Network Load Balancers] The IPv6 address. |
string |
| privateIPv4Address |
[Network Load Balancers] The private IPv4 address for an internal load balancer. |
string |
| subnetId |
The ID of the subnet. |
string |
TagAutoGenerated29
| Name |
Description |
Value |
| key |
The key of the tag. |
string |
| value |
The value of the tag. |
string |