Module: AWSCDK::EC2::IPrefixList

Includes:
IPeer, IResource, Interfaces::AWSEC2::IPrefixListRef
Included in:
PrefixList
Defined in:
ec2/i_prefix_list.rb

Overview

A prefix list.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'ec2/i_prefix_list.rb', line 119

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :can_inline_rule => { kind: :property, name: "canInlineRule", is_optional: false },
    :unique_id => { kind: :property, name: "uniqueId", is_optional: false },
    :prefix_list_ref => { kind: :property, name: "prefixListRef", is_optional: false },
    :prefix_list_id => { kind: :property, name: "prefixListId", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :to_egress_rule_config => { kind: :method, name: "toEgressRuleConfig", is_optional: false },
    :to_ingress_rule_config => { kind: :method, name: "toIngressRuleConfig", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



100
101
102
103
 
# File 'ec2/i_prefix_list.rb', line 100

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#can_inline_rule ⇒ Boolean

Whether the rule can be inlined into a SecurityGroup or not.

Returns:

  • (Boolean) 


49
50
51
 
# File 'ec2/i_prefix_list.rb', line 49

def can_inline_rule()
  jsii_get_property("canInlineRule")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



42
43
44
 
# File 'ec2/i_prefix_list.rb', line 42

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



28
29
30
 
# File 'ec2/i_prefix_list.rb', line 28

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


13
14
15
 
# File 'ec2/i_prefix_list.rb', line 13

def node()
  jsii_get_property("node")
end

#prefix_list_id ⇒ String

The ID of the prefix list.

Returns:

  • (String) 


70
71
72
 
# File 'ec2/i_prefix_list.rb', line 70

def prefix_list_id()
  jsii_get_property("prefixListId")
end

#prefix_list_ref ⇒ AWSCDK::Interfaces::AWSEC2::PrefixListReference

A reference to a PrefixList resource.

Returns:



63
64
65
 
# File 'ec2/i_prefix_list.rb', line 63

def prefix_list_ref()
  jsii_get_property("prefixListRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



35
36
37
 
# File 'ec2/i_prefix_list.rb', line 35

def stack()
  jsii_get_property("stack")
end

#to_egress_rule_config ⇒ AWSCDK::EC2::EgressRuleConfig

Produce the egress rule JSON for the given connection.

Returns:



108
109
110
 
# File 'ec2/i_prefix_list.rb', line 108

def to_egress_rule_config()
  jsii_call_method("toEgressRuleConfig", [])
end

#to_ingress_rule_config ⇒ AWSCDK::EC2::IngressRuleConfig

Produce the ingress rule JSON for the given connection.

Returns:



115
116
117
 
# File 'ec2/i_prefix_list.rb', line 115

def to_ingress_rule_config()
  jsii_call_method("toIngressRuleConfig", [])
end

#unique_id ⇒ String

A unique identifier for this connection peer.

Returns:

  • (String) 


56
57
58
 
# File 'ec2/i_prefix_list.rb', line 56

def unique_id()
  jsii_get_property("uniqueId")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



81
82
83
84
85
86
 
# File 'ec2/i_prefix_list.rb', line 81

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end