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

Class: Aws::ElasticLoadBalancingV2::Types::ModifyListenerInput

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#certificatesArray<Types::Certificate>

The default SSL server certificate.

Returns:



1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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

#default_actionsArray<Types::Action>

The default action. 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:



1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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

#listener_arnString

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String)


1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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

#portInteger

The port for connections from clients to the load balancer.

Returns:

  • (Integer)


1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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

#protocolString

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Returns:

  • (String)


1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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

#ssl_policyString

The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

Returns:

  • (String)


1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 1552

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