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
  port: 1, # required
  ssl_policy: "SslPolicyName",
  certificates: [
    {
      certificate_arn: "CertificateArn",
    },
  ],
  default_actions: [ # required
    {
      type: "forward", # required, accepts forward
      target_group_arn: "TargetGroupArn", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificatesArray<Types::Certificate>

The SSL server certificate. You must provide exactly one certificate if the protocol is HTTPS.

Returns:



176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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.

Returns:



176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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)


176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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)


176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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.

Returns:

  • (String)


176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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

#ssl_policyString

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

Returns:

  • (String)


176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 176

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