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

Class: AWS::ELB::BackendServerPolicyCollection

Inherits:
Object
  • Object
show all
Includes:
Core::Collection::Simple
Defined in:
lib/aws/elb/backend_server_policy_collection.rb

Overview

Helps manage policies assigned to backend server instnace ports.

Creating a Backend Server Policy

Creating a backend server policy can be a bit tricky. A BackendServerAuthenticationPolicyType policy only has one attribute, a list of public key policies.

Before you can assign a policy to a backend server instance port you must create on of the appropriate type:

# step 1, create one (or more) PublicKeyPolicyType policies

public_key1 = <<-KEY
-----BEGIN CERTIFICATE-----
MIICaTCCAdICCQDuvCF4erLGSjANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJa
....
o50MymfqtoVcebZcXbiDVAXW1cPEHKLBXecX6/LZ+GOzEsUOxgt7Xs9uabqp
-----END CERTIFICATE-----
KEY

public_key_policy = load_balancer.policies.create("pkp",
  'PublicKeyPolicyType', 'PublicKey' => public_key.strip)

# step 2, create the backend server policy, passing the public key policy

name = 'backend-policy'
type = 'BackendServerAuthenticationPolicyType'
attributes = {
  # note: you can pass more than one public key policy here
  'PublicKeyPolicyName' => [public_key_policy]
}

backend_policy = @load_balancer.policies.create(name, type, attributes)
  'BackendServerAuthenticationPolicyType', attributes)

Once you have created a backend server authentication policy, you can assign it to a backend instance port:

load_balancer.backend_server_policies[80] = backend_policy

If you want to remove the policy you can pass nil instead.

# removes the policy from instance port 80
load_balancer.backend_server_policies[80] = nil

You can also get the current policy:

load_balancer.backend_server_policies[80] # returns a policy or nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Collection

#each, #each_batch, #enum, #first, #in_groups_of, #page

Constructor Details

#initialize(load_balancer, options = {}) ⇒ BackendServerPolicyCollection

Returns a new instance of BackendServerPolicyCollection



71
72
73
74
 
# File 'lib/aws/elb/backend_server_policy_collection.rb', line 71

def initialize load_balancer, options = {}
  @load_balancer = load_balancer
  super
end

Instance Attribute Details

#load_balancer ⇒ LoadBalancer (readonly)

Returns:



77
78
79
 
# File 'lib/aws/elb/backend_server_policy_collection.rb', line 77

def load_balancer
  @load_balancer
end

Instance Method Details

#[](instance_port) ⇒ LoadBalancerPolicy?

Returns the policy currently assigned to the given instance port.

Parameters:

  • instance_port (Integer) —

    The backend server port to get the currently policy of.

Returns:

  • (LoadBalancerPolicy, nil) —

    Returns the load balancer policy currently assigned to the given instance port. Returns nil if no policy has been assigned.



88
89
90
 
# File 'lib/aws/elb/backend_server_policy_collection.rb', line 88

def [] instance_port
  enum(:instance_port => instance_port).first
end

#[]=(instance_port, policy) ⇒ nil

Sets the policy for the given backend server instance port.

Parameters:

  • instance_port (Integer) —

    The instance port you want to set backend server policies for.

  • policy (String, LoadBalancerPolicy, nil) —

    Load balancer policy name or object. Passing nil removes the current policy.

Returns:

  • (nil) 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws/elb/backend_server_policy_collection.rb', line 102

def []= instance_port, policy

  client.set_load_balancer_policies_for_backend_server(
    :load_balancer_name => load_balancer.name,
    :instance_port => instance_port.to_i,
    :policy_names => [policy_name(policy)].compact)

  nil

end