Class: AWSCDK::EC2::CfnNetworkInterface

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::INetworkInterfaceRef
Defined in:
ec2/cfn_network_interface.rb

Overview

Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNetworkInterface

Create a new AWS::EC2::NetworkInterface.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnNetworkInterfaceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'ec2/cfn_network_interface.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnNetworkInterfaceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5ldHdvcmtJbnRlcmZhY2VQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_network_interface(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'ec2/cfn_network_interface.rb', line 94

def self.arn_for_network_interface(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSU5ldHdvcmtJbnRlcmZhY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInterface", "arnForNetworkInterface", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


214
215
216
 
# File 'ec2/cfn_network_interface.rb', line 214

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

.from_network_interface_id(scope, id, network_interface_id) ⇒ AWSCDK::Interfaces::AWSEC2::INetworkInterfaceRef

Creates a new INetworkInterfaceRef from a networkInterfaceId.

Parameters:

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

Returns:



105
106
107
108
109
110
 
# File 'ec2/cfn_network_interface.rb', line 105

def self.from_network_interface_id(scope, id, network_interface_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(network_interface_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkInterfaceId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInterface", "fromNetworkInterfaceId", [scope, id, network_interface_id])
end

.is_cfn_network_interface(x) ⇒ Boolean

Checks whether the given object is a CfnNetworkInterface.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


116
117
118
119
 
# File 'ec2/cfn_network_interface.rb', line 116

def self.is_cfn_network_interface(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInterface", "isCfnNetworkInterface", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'ec2/cfn_network_interface.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_primary_ipv6_address => { kind: :property, name: "attrPrimaryIpv6Address", is_optional: false },
    :attr_primary_private_ip_address => { kind: :property, name: "attrPrimaryPrivateIpAddress", is_optional: false },
    :attr_public_ip_dns_name_options => { kind: :property, name: "attrPublicIpDnsNameOptions", is_optional: false },
    :attr_secondary_private_ip_addresses => { kind: :property, name: "attrSecondaryPrivateIpAddresses", is_optional: false },
    :attr_vpc_id => { kind: :property, name: "attrVpcId", is_optional: false },
    :network_interface_ref => { kind: :property, name: "networkInterfaceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: false },
    :connection_tracking_specification => { kind: :property, name: "connectionTrackingSpecification", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_primary_ipv6 => { kind: :property, name: "enablePrimaryIpv6", is_optional: true },
    :group_set => { kind: :property, name: "groupSet", is_optional: true },
    :interface_type => { kind: :property, name: "interfaceType", is_optional: true },
    :ipv4_prefix_count => { kind: :property, name: "ipv4PrefixCount", is_optional: true },
    :ipv4_prefixes => { kind: :property, name: "ipv4Prefixes", is_optional: true },
    :ipv6_address_count => { kind: :property, name: "ipv6AddressCount", is_optional: true },
    :ipv6_addresses => { kind: :property, name: "ipv6Addresses", is_optional: true },
    :ipv6_prefix_count => { kind: :property, name: "ipv6PrefixCount", is_optional: true },
    :ipv6_prefixes => { kind: :property, name: "ipv6Prefixes", is_optional: true },
    :private_ip_address => { kind: :property, name: "privateIpAddress", is_optional: true },
    :private_ip_addresses => { kind: :property, name: "privateIpAddresses", is_optional: true },
    :public_ip_dns_hostname_type_specification => { kind: :property, name: "publicIpDnsHostnameTypeSpecification", is_optional: true },
    :secondary_private_ip_address_count => { kind: :property, name: "secondaryPrivateIpAddressCount", is_optional: true },
    :source_dest_check => { kind: :property, name: "sourceDestCheck", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



532
533
534
535
 
# File 'ec2/cfn_network_interface.rb', line 532

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



544
545
546
547
 
# File 'ec2/cfn_network_interface.rb', line 544

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



554
555
556
557
 
# File 'ec2/cfn_network_interface.rb', line 554

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



565
566
567
568
569
 
# File 'ec2/cfn_network_interface.rb', line 565

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


622
623
624
625
626
 
# File 'ec2/cfn_network_interface.rb', line 622

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



632
633
634
635
 
# File 'ec2/cfn_network_interface.rb', line 632

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



644
645
646
647
648
 
# File 'ec2/cfn_network_interface.rb', line 644

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



657
658
659
660
 
# File 'ec2/cfn_network_interface.rb', line 657

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



679
680
681
682
683
684
 
# File 'ec2/cfn_network_interface.rb', line 679

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

The ID of the network interface.

Returns:

  • (String) 


221
222
223
 
# File 'ec2/cfn_network_interface.rb', line 221

def attr_id()
  jsii_get_property("attrId")
end

#attr_primary_ipv6_address ⇒ String

The primary IPv6 address of the network interface.

Returns:

  • (String) 


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

def attr_primary_ipv6_address()
  jsii_get_property("attrPrimaryIpv6Address")
end

#attr_primary_private_ip_address ⇒ String

The primary private IP address of the network interface.

For example, 10.0.0.192 .

Returns:

  • (String) 


237
238
239
 
# File 'ec2/cfn_network_interface.rb', line 237

def attr_primary_private_ip_address()
  jsii_get_property("attrPrimaryPrivateIpAddress")
end

#attr_public_ip_dns_name_options ⇒ AWSCDK::IResolvable

Describes the public hostname type options, including public hostname type, IPv4-enabled public hostname, IPv6-enabled public hostname, and dual-stack public hostname.

Returns:



244
245
246
 
# File 'ec2/cfn_network_interface.rb', line 244

def attr_public_ip_dns_name_options()
  jsii_get_property("attrPublicIpDnsNameOptions")
end

#attr_secondary_private_ip_addresses ⇒ Array<String>

The secondary private IP addresses of the network interface.

For example, ["10.0.0.161", "10.0.0.162", "10.0.0.163"] .

Returns:

  • (Array<String>) 


253
254
255
 
# File 'ec2/cfn_network_interface.rb', line 253

def attr_secondary_private_ip_addresses()
  jsii_get_property("attrSecondaryPrivateIpAddresses")
end

#attr_vpc_id ⇒ String

The ID of the VPC.

Returns:

  • (String) 


260
261
262
 
# File 'ec2/cfn_network_interface.rb', line 260

def attr_vpc_id()
  jsii_get_property("attrVpcId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



167
168
169
 
# File 'ec2/cfn_network_interface.rb', line 167

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


172
173
174
 
# File 'ec2/cfn_network_interface.rb', line 172

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


688
689
690
691
 
# File 'ec2/cfn_network_interface.rb', line 688

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connection_tracking_specification ⇒ AWSCDK::IResolvable, ...

A connection tracking specification for the network interface.

Returns:



293
294
295
 
# File 'ec2/cfn_network_interface.rb', line 293

def connection_tracking_specification()
  jsii_get_property("connectionTrackingSpecification")
end

#connection_tracking_specification=(value) ⇒ Object 



297
298
299
300
301
 
# File 'ec2/cfn_network_interface.rb', line 297

def connection_tracking_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnNetworkInterface::ConnectionTrackingSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuTmV0d29ya0ludGVyZmFjZS5Db25uZWN0aW9uVHJhY2tpbmdTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "connectionTrackingSpecification") unless value.nil?
  jsii_set_property("connectionTrackingSpecification", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


129
130
131
 
# File 'ec2/cfn_network_interface.rb', line 129

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the network interface.

Returns:

  • (String, nil) 


306
307
308
 
# File 'ec2/cfn_network_interface.rb', line 306

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



310
311
312
313
 
# File 'ec2/cfn_network_interface.rb', line 310

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#enable_primary_ipv6 ⇒ Boolean, ...

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address.

Returns:



318
319
320
 
# File 'ec2/cfn_network_interface.rb', line 318

def enable_primary_ipv6()
  jsii_get_property("enablePrimaryIpv6")
end

#enable_primary_ipv6=(value) ⇒ Object 



322
323
324
325
 
# File 'ec2/cfn_network_interface.rb', line 322

def enable_primary_ipv6=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enablePrimaryIpv6") unless value.nil?
  jsii_set_property("enablePrimaryIpv6", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



189
190
191
 
# File 'ec2/cfn_network_interface.rb', line 189

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



701
702
703
704
705
 
# File 'ec2/cfn_network_interface.rb', line 701

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



712
713
714
715
 
# File 'ec2/cfn_network_interface.rb', line 712

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#group_set ⇒ Array<String>?

The IDs of the security groups associated with this network interface.

Returns:

  • (Array<String>, nil) 


330
331
332
 
# File 'ec2/cfn_network_interface.rb', line 330

def group_set()
  jsii_get_property("groupSet")
end

#group_set=(value) ⇒ Object 



334
335
336
337
 
# File 'ec2/cfn_network_interface.rb', line 334

def group_set=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "groupSet") unless value.nil?
  jsii_set_property("groupSet", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



782
783
784
785
 
# File 'ec2/cfn_network_interface.rb', line 782

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#interface_type ⇒ String?

The type of network interface.

Returns:

  • (String, nil) 


342
343
344
 
# File 'ec2/cfn_network_interface.rb', line 342

def interface_type()
  jsii_get_property("interfaceType")
end

#interface_type=(value) ⇒ Object 



346
347
348
349
 
# File 'ec2/cfn_network_interface.rb', line 346

def interface_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "interfaceType") unless value.nil?
  jsii_set_property("interfaceType", value)
end

#ipv4_prefix_count ⇒ Numeric?

The number of IPv4 prefixes to be automatically assigned to the network interface.

Returns:

  • (Numeric, nil) 


354
355
356
 
# File 'ec2/cfn_network_interface.rb', line 354

def ipv4_prefix_count()
  jsii_get_property("ipv4PrefixCount")
end

#ipv4_prefix_count=(value) ⇒ Object 



358
359
360
361
 
# File 'ec2/cfn_network_interface.rb', line 358

def ipv4_prefix_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv4PrefixCount") unless value.nil?
  jsii_set_property("ipv4PrefixCount", value)
end

#ipv4_prefixes ⇒ AWSCDK::IResolvable, ...

The IPv4 delegated prefixes that are assigned to the network interface.

Returns:



366
367
368
 
# File 'ec2/cfn_network_interface.rb', line 366

def ipv4_prefixes()
  jsii_get_property("ipv4Prefixes")
end

#ipv4_prefixes=(value) ⇒ Object 



370
371
372
373
 
# File 'ec2/cfn_network_interface.rb', line 370

def ipv4_prefixes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5ldHdvcmtJbnRlcmZhY2UuSXB2NFByZWZpeFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "ipv4Prefixes") unless value.nil?
  jsii_set_property("ipv4Prefixes", value)
end

#ipv6_address_count ⇒ Numeric?

The number of IPv6 addresses to assign to the network interface.

Returns:

  • (Numeric, nil) 


378
379
380
 
# File 'ec2/cfn_network_interface.rb', line 378

def ipv6_address_count()
  jsii_get_property("ipv6AddressCount")
end

#ipv6_address_count=(value) ⇒ Object 



382
383
384
385
 
# File 'ec2/cfn_network_interface.rb', line 382

def ipv6_address_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv6AddressCount") unless value.nil?
  jsii_set_property("ipv6AddressCount", value)
end

#ipv6_addresses ⇒ AWSCDK::IResolvable, ...

The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.

Returns:



390
391
392
 
# File 'ec2/cfn_network_interface.rb', line 390

def ipv6_addresses()
  jsii_get_property("ipv6Addresses")
end

#ipv6_addresses=(value) ⇒ Object 



394
395
396
397
 
# File 'ec2/cfn_network_interface.rb', line 394

def ipv6_addresses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5ldHdvcmtJbnRlcmZhY2UuSW5zdGFuY2VJcHY2QWRkcmVzc1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "ipv6Addresses") unless value.nil?
  jsii_set_property("ipv6Addresses", value)
end

#ipv6_prefix_count ⇒ Numeric?

The number of IPv6 prefixes to be automatically assigned to the network interface.

Returns:

  • (Numeric, nil) 


402
403
404
 
# File 'ec2/cfn_network_interface.rb', line 402

def ipv6_prefix_count()
  jsii_get_property("ipv6PrefixCount")
end

#ipv6_prefix_count=(value) ⇒ Object 



406
407
408
409
 
# File 'ec2/cfn_network_interface.rb', line 406

def ipv6_prefix_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv6PrefixCount") unless value.nil?
  jsii_set_property("ipv6PrefixCount", value)
end

#ipv6_prefixes ⇒ AWSCDK::IResolvable, ...

The IPv6 delegated prefixes that are assigned to the network interface.

Returns:



414
415
416
 
# File 'ec2/cfn_network_interface.rb', line 414

def ipv6_prefixes()
  jsii_get_property("ipv6Prefixes")
end

#ipv6_prefixes=(value) ⇒ Object 



418
419
420
421
 
# File 'ec2/cfn_network_interface.rb', line 418

def ipv6_prefixes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5ldHdvcmtJbnRlcmZhY2UuSXB2NlByZWZpeFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "ipv6Prefixes") unless value.nil?
  jsii_set_property("ipv6Prefixes", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


141
142
143
 
# File 'ec2/cfn_network_interface.rb', line 141

def logical_id()
  jsii_get_property("logicalId")
end

#network_interface_ref ⇒ AWSCDK::Interfaces::AWSEC2::NetworkInterfaceReference

A reference to a NetworkInterface resource.

Returns:



267
268
269
 
# File 'ec2/cfn_network_interface.rb', line 267

def network_interface_ref()
  jsii_get_property("networkInterfaceRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


124
125
126
 
# File 'ec2/cfn_network_interface.rb', line 124

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



723
724
725
 
# File 'ec2/cfn_network_interface.rb', line 723

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



730
731
732
 
# File 'ec2/cfn_network_interface.rb', line 730

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



523
524
525
526
 
# File 'ec2/cfn_network_interface.rb', line 523

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#private_ip_address ⇒ String?

The private IPv4 address to assign to the network interface as the primary private IP address.

Returns:

  • (String, nil) 


426
427
428
 
# File 'ec2/cfn_network_interface.rb', line 426

def private_ip_address()
  jsii_get_property("privateIpAddress")
end

#private_ip_address=(value) ⇒ Object 



430
431
432
433
 
# File 'ec2/cfn_network_interface.rb', line 430

def private_ip_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateIpAddress") unless value.nil?
  jsii_set_property("privateIpAddress", value)
end

#private_ip_addresses ⇒ AWSCDK::IResolvable, ...

The private IPv4 addresses to assign to the network interface.

Returns:



438
439
440
 
# File 'ec2/cfn_network_interface.rb', line 438

def private_ip_addresses()
  jsii_get_property("privateIpAddresses")
end

#private_ip_addresses=(value) ⇒ Object 



442
443
444
445
 
# File 'ec2/cfn_network_interface.rb', line 442

def private_ip_addresses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbk5ldHdvcmtJbnRlcmZhY2UuUHJpdmF0ZUlwQWRkcmVzc1NwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "privateIpAddresses") unless value.nil?
  jsii_set_property("privateIpAddresses", value)
end

#public_ip_dns_hostname_type_specification ⇒ String?

Public IP DNS hostname type.

Returns:

  • (String, nil) 


450
451
452
 
# File 'ec2/cfn_network_interface.rb', line 450

def public_ip_dns_hostname_type_specification()
  jsii_get_property("publicIpDnsHostnameTypeSpecification")
end

#public_ip_dns_hostname_type_specification=(value) ⇒ Object 



454
455
456
457
 
# File 'ec2/cfn_network_interface.rb', line 454

def public_ip_dns_hostname_type_specification=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publicIpDnsHostnameTypeSpecification") unless value.nil?
  jsii_set_property("publicIpDnsHostnameTypeSpecification", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


160
161
162
 
# File 'ec2/cfn_network_interface.rb', line 160

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



741
742
743
744
 
# File 'ec2/cfn_network_interface.rb', line 741

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


748
749
750
751
 
# File 'ec2/cfn_network_interface.rb', line 748

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



758
759
760
761
762
 
# File 'ec2/cfn_network_interface.rb', line 758

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#secondary_private_ip_address_count ⇒ Numeric?

The number of secondary private IPv4 addresses to assign to a network interface.

Returns:

  • (Numeric, nil) 


462
463
464
 
# File 'ec2/cfn_network_interface.rb', line 462

def secondary_private_ip_address_count()
  jsii_get_property("secondaryPrivateIpAddressCount")
end

#secondary_private_ip_address_count=(value) ⇒ Object 



466
467
468
469
 
# File 'ec2/cfn_network_interface.rb', line 466

def secondary_private_ip_address_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "secondaryPrivateIpAddressCount") unless value.nil?
  jsii_set_property("secondaryPrivateIpAddressCount", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



767
768
769
 
# File 'ec2/cfn_network_interface.rb', line 767

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_dest_check ⇒ Boolean, ...

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

Returns:



474
475
476
 
# File 'ec2/cfn_network_interface.rb', line 474

def source_dest_check()
  jsii_get_property("sourceDestCheck")
end

#source_dest_check=(value) ⇒ Object 



478
479
480
481
 
# File 'ec2/cfn_network_interface.rb', line 478

def source_dest_check=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "sourceDestCheck") unless value.nil?
  jsii_set_property("sourceDestCheck", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



150
151
152
 
# File 'ec2/cfn_network_interface.rb', line 150

def stack()
  jsii_get_property("stack")
end

#subnet_id ⇒ String

The ID of the subnet to associate with the network interface.

Returns:

  • (String) 


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

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



285
286
287
288
 
# File 'ec2/cfn_network_interface.rb', line 285

def subnet_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetId")
  jsii_set_property("subnetId", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



274
275
276
 
# File 'ec2/cfn_network_interface.rb', line 274

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to apply to the network interface.

Returns:



486
487
488
 
# File 'ec2/cfn_network_interface.rb', line 486

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



490
491
492
493
494
 
# File 'ec2/cfn_network_interface.rb', line 490

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



499
500
501
 
# File 'ec2/cfn_network_interface.rb', line 499

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


197
198
199
 
# File 'ec2/cfn_network_interface.rb', line 197

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


207
208
209
 
# File 'ec2/cfn_network_interface.rb', line 207

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


773
774
775
776
 
# File 'ec2/cfn_network_interface.rb', line 773

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


512
513
514
515
516
517
 
# File 'ec2/cfn_network_interface.rb', line 512

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