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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
      private_i_pv_4_address: "PrivateIPv4Address",
      i_pv_6_address: "IPv6Address",
    },
  ],
  security_groups: ["SecurityGroupId"],
  scheme: "internet-facing", # accepts internet-facing, internal
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  type: "application", # accepts application, network, gateway
  ip_address_type: "ipv4", # accepts ipv4, dualstack
  customer_owned_ipv_4_pool: "CustomerOwnedIpv4Pool",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_owned_ipv_4_poolString

[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

Returns:

  • (String)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#ip_address_typeString

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)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type,
  :customer_owned_ipv_4_pool)
  SENSITIVE = []
  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, must not begin or end with a hyphen, and must not begin with “internal-”.

Returns:

  • (String)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

class CreateLoadBalancerInput < Struct.new(
  :name,
  :subnets,
  :subnet_mappings,
  :security_groups,
  :scheme,
  :tags,
  :type,
  :ip_address_type,
  :customer_owned_ipv_4_pool)
  SENSITIVE = []
  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 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.

Returns:

  • (String)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#security_groupsArray<String>

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

Returns:

  • (Array<String>)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#subnet_mappingsArray<Types::SubnetMapping>

The IDs of the public subnets. 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. 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.

Returns:


834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#subnetsArray<String>

The IDs of the public subnets. 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.

[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.

Returns:

  • (Array<String>)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#tagsArray<Types::Tag>

The tags to assign to the load balancer.

Returns:


834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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

#typeString

The type of load balancer. The default is `application`.

Returns:

  • (String)

834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 834

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