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

Class: Aws::ElasticLoadBalancingV2::Types::CreateListenerInput

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 CreateListenerInput data as a hash:

{
  load_balancer_arn: "LoadBalancerArn", # required
  protocol: "HTTP", # required, accepts HTTP, HTTPS, TCP
  port: 1, # required
  ssl_policy: "SslPolicyName",
  certificates: [
    {
      certificate_arn: "CertificateArn",
      is_default: false,
    },
  ],
  default_actions: [ # required
    {
      type: "forward", # required, accepts forward
      target_group_arn: "TargetGroupArn", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificatesArray<Types::Certificate>

[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.

Returns:



233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end

#default_actionsArray<Types::Action>

The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.

Returns:



233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end

#load_balancer_arnString

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

Returns:

  • (String)


233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end

#portInteger

The port on which the load balancer is listening.

Returns:

  • (Integer)


233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end

#protocolString

The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.

Returns:

  • (String)


233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end

#ssl_policyString

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

Returns:

  • (String)


233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 233

class CreateListenerInput < Struct.new(
  :load_balancer_arn,
  :protocol,
  :port,
  :ssl_policy,
  :certificates,
  :default_actions)
  include Aws::Structure
end