Class: AWSCDK::EC2::PrefixList

Inherits:
Resource
  • Object
show all
Includes:
IPrefixList
Defined in:
ec2/prefix_list.rb

Overview

A managed prefix list.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ PrefixList

Returns a new instance of PrefixList.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/prefix_list.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::PrefixListProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlByZWZpeExpc3RQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_lookup(scope, id, options) ⇒ AWSCDK::EC2::IPrefixList

Look up prefix list by name.

Parameters:

Returns:



54
55
56
57
58
59
60
 
# File 'ec2/prefix_list.rb', line 54

def self.from_lookup(scope, id, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::PrefixListLookupOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlByZWZpeExpc3RMb29rdXBPcHRpb25zIn0=")), "options")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.PrefixList", "fromLookup", [scope, id, options])
end

.from_prefix_list_id(scope, id, prefix_list_id) ⇒ AWSCDK::EC2::IPrefixList

Look up prefix list by id.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • prefix_list_id (String)

Returns:



68
69
70
71
72
73
 
# File 'ec2/prefix_list.rb', line 68

def self.from_prefix_list_id(scope, id, prefix_list_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(prefix_list_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefixListId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.PrefixList", "fromPrefixListId", [scope, id, prefix_list_id])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'ec2/prefix_list.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :address_family => { kind: :property, name: "addressFamily", is_optional: false },
    :can_inline_rule => { kind: :property, name: "canInlineRule", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :owner_id => { kind: :property, name: "ownerId", is_optional: false },
    :prefix_list_arn => { kind: :property, name: "prefixListArn", is_optional: false },
    :prefix_list_id => { kind: :property, name: "prefixListId", is_optional: false },
    :prefix_list_name => { kind: :property, name: "prefixListName", is_optional: false },
    :prefix_list_ref => { kind: :property, name: "prefixListRef", is_optional: false },
    :unique_id => { kind: :property, name: "uniqueId", is_optional: false },
    :version => { kind: :property, name: "version", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", 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

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


121
122
123
 
# File 'ec2/prefix_list.rb', line 121

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.PrefixList", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#address_family ⇒ String

The address family of the prefix list.

Returns:

  • (String) 


128
129
130
 
# File 'ec2/prefix_list.rb', line 128

def address_family()
  jsii_get_property("addressFamily")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



228
229
230
231
 
# File 'ec2/prefix_list.rb', line 228

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#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:



245
246
247
248
 
# File 'ec2/prefix_list.rb', line 245

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) 


135
136
137
 
# File 'ec2/prefix_list.rb', line 135

def can_inline_rule()
  jsii_get_property("canInlineRule")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



142
143
144
 
# File 'ec2/prefix_list.rb', line 142

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:



93
94
95
 
# File 'ec2/prefix_list.rb', line 93

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


251
252
253
 
# File 'ec2/prefix_list.rb', line 251

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


265
266
267
268
269
270
 
# File 'ec2/prefix_list.rb', line 265

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


280
281
282
283
 
# File 'ec2/prefix_list.rb', line 280

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


78
79
80
 
# File 'ec2/prefix_list.rb', line 78

def node()
  jsii_get_property("node")
end

#owner_id ⇒ String

The owner ID of the prefix list.

Returns:

  • (String) 


149
150
151
 
# File 'ec2/prefix_list.rb', line 149

def owner_id()
  jsii_get_property("ownerId")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


107
108
109
 
# File 'ec2/prefix_list.rb', line 107

def physical_name()
  jsii_get_property("physicalName")
end

#prefix_list_arn ⇒ String

The ARN of the prefix list.

Returns:

  • (String) 


156
157
158
 
# File 'ec2/prefix_list.rb', line 156

def prefix_list_arn()
  jsii_get_property("prefixListArn")
end

#prefix_list_id ⇒ String

The ID of the prefix list.

Returns:

  • (String) 


163
164
165
 
# File 'ec2/prefix_list.rb', line 163

def prefix_list_id()
  jsii_get_property("prefixListId")
end

#prefix_list_name ⇒ String

The name of the prefix list.

Returns:

  • (String) 


170
171
172
 
# File 'ec2/prefix_list.rb', line 170

def prefix_list_name()
  jsii_get_property("prefixListName")
end

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

A reference to a PrefixList resource.

Returns:



177
178
179
 
# File 'ec2/prefix_list.rb', line 177

def prefix_list_ref()
  jsii_get_property("prefixListRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



114
115
116
 
# File 'ec2/prefix_list.rb', line 114

def stack()
  jsii_get_property("stack")
end

#to_egress_rule_config ⇒ AWSCDK::EC2::EgressRuleConfig

Produce the egress rule JSON for the given connection.

Returns:



288
289
290
 
# File 'ec2/prefix_list.rb', line 288

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:



295
296
297
 
# File 'ec2/prefix_list.rb', line 295

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


198
199
200
 
# File 'ec2/prefix_list.rb', line 198

def to_string()
  jsii_call_method("toString", [])
end

#unique_id ⇒ String

A unique identifier for this connection peer.

Returns:

  • (String) 


184
185
186
 
# File 'ec2/prefix_list.rb', line 184

def unique_id()
  jsii_get_property("uniqueId")
end

#version ⇒ Numeric

The version of the prefix list.

Returns:

  • (Numeric) 


191
192
193
 
# File 'ec2/prefix_list.rb', line 191

def version()
  jsii_get_property("version")
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


211
212
213
214
215
216
 
# File 'ec2/prefix_list.rb', line 211

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