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

Class: Aws::ElasticLoadBalancing::Types::CreateAccessPointInput

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

Overview

Note:

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

{
  load_balancer_name: "AccessPointName", # required
  listeners: [ # required
    {
      protocol: "Protocol", # required
      load_balancer_port: 1, # required
      instance_protocol: "Protocol",
      instance_port: 1, # required
      ssl_certificate_id: "SSLCertificateId",
    },
  ],
  availability_zones: ["AvailabilityZone"],
  subnets: ["SubnetId"],
  security_groups: ["SecurityGroupId"],
  scheme: "LoadBalancerScheme",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Contains the parameters for CreateLoadBalancer.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

One or more Availability Zones from the same region as the load balancer.

You must specify at least one Availability Zone.

You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

Returns:

  • (Array<String>)


469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#listenersArray<Types::Listener>

The listeners.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancer Guide.

Returns:



469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#load_balancer_nameString

The name of the load balancer.

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#schemeString

The type of a load balancer. Valid only for load balancers in a VPC.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#security_groupsArray<String>

The IDs of the security groups to assign to the load balancer.

Returns:

  • (Array<String>)


469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#subnetsArray<String>

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

Returns:

  • (Array<String>)


469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to assign to the load balancer.

For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancer Guide.

Returns:



469
470
471
472
473
474
475
476
477
478
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 469

class CreateAccessPointInput < Struct.new(
  :load_balancer_name,
  :listeners,
  :availability_zones,
  :subnets,
  :security_groups,
  :scheme,
  :tags)
  include Aws::Structure
end