Class: AWSCDK::CloudAssemblySchema::LoadBalancerListenerContextQuery

Inherits:
LoadBalancerFilter
  • Object
show all
Defined in:
cloud_assembly_schema/load_balancer_listener_context_query.rb

Overview

Query input for looking up a load balancer listener.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account:, region:, assume_role_additional_options: nil, lookup_role_arn: nil, lookup_role_external_id: nil, load_balancer_type:, load_balancer_arn: nil, load_balancer_tags: nil, listener_arn: nil, listener_port: nil, listener_protocol: nil) ⇒ LoadBalancerListenerContextQuery

Returns a new instance of LoadBalancerListenerContextQuery.

Parameters:

  • account (String) —

    Query account.

  • region (String) —

    Query region.

  • assume_role_additional_options (Hash{String => Object}, nil) (defaults to: nil) —

    Additional options to pass to STS when assuming the lookup role.

  • lookup_role_arn (String, nil) (defaults to: nil) —

    The ARN of the role that should be used to look up the missing values.

  • lookup_role_external_id (String, nil) (defaults to: nil) —

    The ExternalId that needs to be supplied while assuming this role.

  • load_balancer_type (AWSCDK::CloudAssemblySchema::LoadBalancerType) —

    Filter load balancers by their type.

  • load_balancer_arn (String, nil) (defaults to: nil) —

    Find by load balancer's ARN.

  • load_balancer_tags (Array<AWSCDK::CloudAssemblySchema::Tag>, nil) (defaults to: nil) —

    Match load balancer tags.

  • listener_arn (String, nil) (defaults to: nil) —

    Find by listener's arn.

  • listener_port (Numeric, nil) (defaults to: nil) —

    Filter listeners by listener port.

  • listener_protocol (AWSCDK::CloudAssemblySchema::LoadBalancerListenerProtocol, nil) (defaults to: nil) —

    Filter by listener protocol.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 18

def initialize(account:, region:, assume_role_additional_options: nil, lookup_role_arn: nil, lookup_role_external_id: nil, load_balancer_type:, load_balancer_arn: nil, load_balancer_tags: nil, listener_arn: nil, listener_port: nil, listener_protocol: nil)
  @account = 
  Jsii::Type.check_type(@account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "account")
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  @assume_role_additional_options = assume_role_additional_options
  Jsii::Type.check_type(@assume_role_additional_options, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assumeRoleAdditionalOptions") unless @assume_role_additional_options.nil?
  @lookup_role_arn = lookup_role_arn
  Jsii::Type.check_type(@lookup_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lookupRoleArn") unless @lookup_role_arn.nil?
  @lookup_role_external_id = lookup_role_external_id
  Jsii::Type.check_type(@lookup_role_external_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lookupRoleExternalId") unless @lookup_role_external_id.nil?
  @load_balancer_type = load_balancer_type
  Jsii::Type.check_type(@load_balancer_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuTG9hZEJhbGFuY2VyVHlwZSJ9")), "loadBalancerType")
  @load_balancer_arn = load_balancer_arn
  Jsii::Type.check_type(@load_balancer_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerArn") unless @load_balancer_arn.nil?
  @load_balancer_tags = load_balancer_tags.is_a?(Array) ? load_balancer_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CloudAssemblySchema::Tag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : load_balancer_tags
  Jsii::Type.check_type(@load_balancer_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmNsb3VkX2Fzc2VtYmx5X3NjaGVtYS5UYWcifSwia2luZCI6ImFycmF5In19")), "loadBalancerTags") unless @load_balancer_tags.nil?
  @listener_arn = listener_arn
  Jsii::Type.check_type(@listener_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "listenerArn") unless @listener_arn.nil?
  @listener_port = listener_port
  Jsii::Type.check_type(@listener_port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "listenerPort") unless @listener_port.nil?
  @listener_protocol = listener_protocol
  Jsii::Type.check_type(@listener_protocol, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuTG9hZEJhbGFuY2VyTGlzdGVuZXJQcm90b2NvbCJ9")), "listenerProtocol") unless @listener_protocol.nil?
end

Instance Attribute Details

#account ⇒ String (readonly)

Query account.

Returns:

  • (String) 


46
47
48
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 46

def 
  @account
end

#assume_role_additional_options ⇒ Hash{String => Object}? (readonly)

Note:

Default: - No additional options.

Additional options to pass to STS when assuming the lookup role.

  • RoleArn should not be used. Use the dedicated lookup_role_arn property instead.
  • ExternalId should not be used. Use the dedicated lookup_role_external_id instead.

Returns:

  • (Hash{String => Object}, nil)

See Also:



59
60
61
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 59

def assume_role_additional_options
  @assume_role_additional_options
end

#listener_arn ⇒ String? (readonly)

Note:

Default: - does not find by listener arn

Find by listener's arn.

Returns:

  • (String, nil) 


88
89
90
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 88

def listener_arn
  @listener_arn
end

#listener_port ⇒ Numeric? (readonly)

Note:

Default: - does not filter by a listener port

Filter listeners by listener port.

Returns:

  • (Numeric, nil) 


93
94
95
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 93

def listener_port
  @listener_port
end

#listener_protocol ⇒ AWSCDK::CloudAssemblySchema::LoadBalancerListenerProtocol? (readonly)

Note:

Default: - does not filter by listener protocol

Filter by listener protocol.

Returns:



98
99
100
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 98

def listener_protocol
  @listener_protocol
end

#load_balancer_arn ⇒ String? (readonly)

Note:

Default: - does not search by load balancer arn

Find by load balancer's ARN.

Returns:

  • (String, nil) 


78
79
80
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 78

def load_balancer_arn
  @load_balancer_arn
end

#load_balancer_tags ⇒ Array<AWSCDK::CloudAssemblySchema::Tag>? (readonly)

Note:

Default: - does not match load balancers by tags

Match load balancer tags.

Returns:



83
84
85
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 83

def load_balancer_tags
  @load_balancer_tags
end

#load_balancer_type ⇒ AWSCDK::CloudAssemblySchema::LoadBalancerType (readonly)

Filter load balancers by their type.

Returns:



73
74
75
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 73

def load_balancer_type
  @load_balancer_type
end

#lookup_role_arn ⇒ String? (readonly)

Note:

Default: - None

The ARN of the role that should be used to look up the missing values.

Returns:

  • (String, nil) 


64
65
66
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 64

def lookup_role_arn
  @lookup_role_arn
end

#lookup_role_external_id ⇒ String? (readonly)

Note:

Default: - No ExternalId will be supplied

The ExternalId that needs to be supplied while assuming this role.

Returns:

  • (String, nil) 


69
70
71
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 69

def lookup_role_external_id
  @lookup_role_external_id
end

#region ⇒ String (readonly)

Query region.

Returns:

  • (String) 


50
51
52
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 50

def region
  @region
end

Class Method Details

.jsii_properties ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 100

def self.jsii_properties
  {
    :account => "account",
    :region => "region",
    :assume_role_additional_options => "assumeRoleAdditionalOptions",
    :lookup_role_arn => "lookupRoleArn",
    :lookup_role_external_id => "lookupRoleExternalId",
    :load_balancer_type => "loadBalancerType",
    :load_balancer_arn => "loadBalancerArn",
    :load_balancer_tags => "loadBalancerTags",
    :listener_arn => "listenerArn",
    :listener_port => "listenerPort",
    :listener_protocol => "listenerProtocol",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'cloud_assembly_schema/load_balancer_listener_context_query.rb', line 116

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "account" => @account,
    "region" => @region,
    "assumeRoleAdditionalOptions" => @assume_role_additional_options,
    "lookupRoleArn" => @lookup_role_arn,
    "lookupRoleExternalId" => @lookup_role_external_id,
    "loadBalancerType" => @load_balancer_type,
    "loadBalancerArn" => @load_balancer_arn,
    "loadBalancerTags" => @load_balancer_tags,
    "listenerArn" => @listener_arn,
    "listenerPort" => @listener_port,
    "listenerProtocol" => @listener_protocol,
  })
  result.compact
end