You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::CreateLoadBalancerInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

When making an API call, you may pass CreateLoadBalancerInput data as a hash:

{
  name: "LoadBalancerName", # required
  subnets: ["SubnetId"],
  subnet_mappings: [
    {
      subnet_id: "SubnetId",
      allocation_id: "AllocationId",
    },
  ],
  security_groups: ["SecurityGroupId"],
  scheme: "internet-facing", # accepts internet-facing, internal
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  type: "application", # accepts application, network
  ip_address_type: "ipv4", # accepts ipv4, dualstack
}

Instance Attribute Summary collapse

Instance Attribute Details

#ip_address_typeString

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#nameString

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, and must not begin or end with a hyphen.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#schemeString

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 only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#security_groupsArray<String>

[Application Load Balancers] The IDs of the security groups to assign to the load balancer.

Returns:

  • (Array<String>)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#subnet_mappingsArray<Types::SubnetMapping>

The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Network Load Balancers] You can specify one Elastic IP address per subnet.

[Application Load Balancers] You cannot specify Elastic IP addresses for your subnets.

Returns:



345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#subnetsArray<String>

The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

Returns:

  • (Array<String>)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags to assign to the load balancer.

Returns:



345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end

#typeString

The type of load balancer to create. The default is application.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
355
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 345

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type)
  include Aws::Structure
end