Class: AWSCDK::EC2::CfnNetworkInsightsAnalysis

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

Overview

Specifies a network insights analysis.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNetworkInsightsAnalysis

Create a new AWS::EC2::NetworkInsightsAnalysis.

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::CfnNetworkInsightsAnalysisProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_network_insights_analysis(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'ec2/cfn_network_insights_analysis.rb', line 86

def self.arn_for_network_insights_analysis(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSU5ldHdvcmtJbnNpZ2h0c0FuYWx5c2lzUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInsightsAnalysis", "arnForNetworkInsightsAnalysis", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


219
220
221
 
# File 'ec2/cfn_network_insights_analysis.rb', line 219

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

.from_network_insights_analysis_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::INetworkInsightsAnalysisRef

Creates a new INetworkInsightsAnalysisRef from an ARN.

Parameters:

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

Returns:



97
98
99
100
101
102
 
# File 'ec2/cfn_network_insights_analysis.rb', line 97

def self.from_network_insights_analysis_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInsightsAnalysis", "fromNetworkInsightsAnalysisArn", [scope, id, arn])
end

.from_network_insights_analysis_id(scope, id, network_insights_analysis_id) ⇒ AWSCDK::Interfaces::AWSEC2::INetworkInsightsAnalysisRef

Creates a new INetworkInsightsAnalysisRef from a networkInsightsAnalysisId.

Parameters:

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

Returns:



110
111
112
113
114
115
 
# File 'ec2/cfn_network_insights_analysis.rb', line 110

def self.from_network_insights_analysis_id(scope, id, network_insights_analysis_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_insights_analysis_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkInsightsAnalysisId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInsightsAnalysis", "fromNetworkInsightsAnalysisId", [scope, id, network_insights_analysis_id])
end

.is_cfn_network_insights_analysis(x) ⇒ Boolean

Checks whether the given object is a CfnNetworkInsightsAnalysis.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_network_insights_analysis(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnNetworkInsightsAnalysis", "isCfnNetworkInsightsAnalysis", [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
 
# File 'ec2/cfn_network_insights_analysis.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_alternate_path_hints => { kind: :property, name: "attrAlternatePathHints", is_optional: false },
    :attr_explanations => { kind: :property, name: "attrExplanations", is_optional: false },
    :attr_forward_path_components => { kind: :property, name: "attrForwardPathComponents", is_optional: false },
    :attr_network_insights_analysis_arn => { kind: :property, name: "attrNetworkInsightsAnalysisArn", is_optional: false },
    :attr_network_insights_analysis_id => { kind: :property, name: "attrNetworkInsightsAnalysisId", is_optional: false },
    :attr_network_path_found => { kind: :property, name: "attrNetworkPathFound", is_optional: false },
    :attr_return_path_components => { kind: :property, name: "attrReturnPathComponents", is_optional: false },
    :attr_start_date => { kind: :property, name: "attrStartDate", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_message => { kind: :property, name: "attrStatusMessage", is_optional: false },
    :attr_suggested_accounts => { kind: :property, name: "attrSuggestedAccounts", is_optional: false },
    :network_insights_analysis_ref => { kind: :property, name: "networkInsightsAnalysisRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :network_insights_path_id => { kind: :property, name: "networkInsightsPathId", is_optional: false },
    :additional_accounts => { kind: :property, name: "additionalAccounts", is_optional: true },
    :filter_in_arns => { kind: :property, name: "filterInArns", is_optional: true },
    :filter_out_arns => { kind: :property, name: "filterOutArns", 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.



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

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:



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

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:



435
436
437
438
 
# File 'ec2/cfn_network_insights_analysis.rb', line 435

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:



446
447
448
449
450
 
# File 'ec2/cfn_network_insights_analysis.rb', line 446

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.


503
504
505
506
507
 
# File 'ec2/cfn_network_insights_analysis.rb', line 503

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.



513
514
515
516
 
# File 'ec2/cfn_network_insights_analysis.rb', line 513

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.



525
526
527
528
529
 
# File 'ec2/cfn_network_insights_analysis.rb', line 525

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

#additional_accounts ⇒ Array<String>?

The member accounts that contain resources that the path can traverse.

Returns:

  • (Array<String>, nil) 


331
332
333
 
# File 'ec2/cfn_network_insights_analysis.rb', line 331

def additional_accounts()
  jsii_get_property("additionalAccounts")
end

#additional_accounts=(value) ⇒ Object 



335
336
337
338
 
# File 'ec2/cfn_network_insights_analysis.rb', line 335

def additional_accounts=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "additionalAccounts") unless value.nil?
  jsii_set_property("additionalAccounts", 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:



538
539
540
541
 
# File 'ec2/cfn_network_insights_analysis.rb', line 538

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:



560
561
562
563
564
565
 
# File 'ec2/cfn_network_insights_analysis.rb', line 560

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_alternate_path_hints ⇒ AWSCDK::IResolvable

Potential intermediate components.

Returns:



226
227
228
 
# File 'ec2/cfn_network_insights_analysis.rb', line 226

def attr_alternate_path_hints()
  jsii_get_property("attrAlternatePathHints")
end

#attr_explanations ⇒ AWSCDK::IResolvable

The explanations.

For more information, see Reachability Analyzer explanation codes .

Returns:



235
236
237
 
# File 'ec2/cfn_network_insights_analysis.rb', line 235

def attr_explanations()
  jsii_get_property("attrExplanations")
end

#attr_forward_path_components ⇒ AWSCDK::IResolvable

The components in the path from source to destination.

Returns:



242
243
244
 
# File 'ec2/cfn_network_insights_analysis.rb', line 242

def attr_forward_path_components()
  jsii_get_property("attrForwardPathComponents")
end

#attr_network_insights_analysis_arn ⇒ String

The Amazon Resource Name (ARN) of the network insights analysis.

Returns:

  • (String) 


249
250
251
 
# File 'ec2/cfn_network_insights_analysis.rb', line 249

def attr_network_insights_analysis_arn()
  jsii_get_property("attrNetworkInsightsAnalysisArn")
end

#attr_network_insights_analysis_id ⇒ String

The ID of the network insights analysis.

Returns:

  • (String) 


256
257
258
 
# File 'ec2/cfn_network_insights_analysis.rb', line 256

def attr_network_insights_analysis_id()
  jsii_get_property("attrNetworkInsightsAnalysisId")
end

#attr_network_path_found ⇒ AWSCDK::IResolvable

Indicates whether the destination is reachable from the source.

Returns:



263
264
265
 
# File 'ec2/cfn_network_insights_analysis.rb', line 263

def attr_network_path_found()
  jsii_get_property("attrNetworkPathFound")
end

#attr_return_path_components ⇒ AWSCDK::IResolvable

The components in the path from destination to source.

Returns:



270
271
272
 
# File 'ec2/cfn_network_insights_analysis.rb', line 270

def attr_return_path_components()
  jsii_get_property("attrReturnPathComponents")
end

#attr_start_date ⇒ String

The time the analysis started.

Returns:

  • (String) 


277
278
279
 
# File 'ec2/cfn_network_insights_analysis.rb', line 277

def attr_start_date()
  jsii_get_property("attrStartDate")
end

#attr_status ⇒ String

The status of the network insights analysis.

Returns:

  • (String) 


284
285
286
 
# File 'ec2/cfn_network_insights_analysis.rb', line 284

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_message ⇒ String

The status message, if the status is failed .

Returns:

  • (String) 


291
292
293
 
# File 'ec2/cfn_network_insights_analysis.rb', line 291

def attr_status_message()
  jsii_get_property("attrStatusMessage")
end

#attr_suggested_accounts ⇒ Array<String>

The IDs of potential intermediate accounts.

Returns:

  • (Array<String>) 


298
299
300
 
# File 'ec2/cfn_network_insights_analysis.rb', line 298

def attr_suggested_accounts()
  jsii_get_property("attrSuggestedAccounts")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


569
570
571
572
 
# File 'ec2/cfn_network_insights_analysis.rb', line 569

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}) 


182
183
184
 
# File 'ec2/cfn_network_insights_analysis.rb', line 182

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


134
135
136
 
# File 'ec2/cfn_network_insights_analysis.rb', line 134

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



194
195
196
 
# File 'ec2/cfn_network_insights_analysis.rb', line 194

def env()
  jsii_get_property("env")
end

#filter_in_arns ⇒ Array<String>?

The Amazon Resource Names (ARN) of the resources that the path must traverse.

Returns:

  • (Array<String>, nil) 


343
344
345
 
# File 'ec2/cfn_network_insights_analysis.rb', line 343

def filter_in_arns()
  jsii_get_property("filterInArns")
end

#filter_in_arns=(value) ⇒ Object 



347
348
349
350
 
# File 'ec2/cfn_network_insights_analysis.rb', line 347

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

#filter_out_arns ⇒ Array<String>?

The Amazon Resource Names (ARN) of the resources that the path must ignore.

Returns:

  • (Array<String>, nil) 


355
356
357
 
# File 'ec2/cfn_network_insights_analysis.rb', line 355

def filter_out_arns()
  jsii_get_property("filterOutArns")
end

#filter_out_arns=(value) ⇒ Object 



359
360
361
362
 
# File 'ec2/cfn_network_insights_analysis.rb', line 359

def filter_out_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "filterOutArns") unless value.nil?
  jsii_set_property("filterOutArns", value)
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:



582
583
584
585
586
 
# File 'ec2/cfn_network_insights_analysis.rb', line 582

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:



593
594
595
596
 
# File 'ec2/cfn_network_insights_analysis.rb', line 593

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



663
664
665
666
 
# File 'ec2/cfn_network_insights_analysis.rb', line 663

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


146
147
148
 
# File 'ec2/cfn_network_insights_analysis.rb', line 146

def logical_id()
  jsii_get_property("logicalId")
end

#network_insights_analysis_ref ⇒ AWSCDK::Interfaces::AWSEC2::NetworkInsightsAnalysisReference

A reference to a NetworkInsightsAnalysis resource.

Returns:



305
306
307
 
# File 'ec2/cfn_network_insights_analysis.rb', line 305

def network_insights_analysis_ref()
  jsii_get_property("networkInsightsAnalysisRef")
end

#network_insights_path_id ⇒ String

The ID of the path.

Returns:

  • (String) 


319
320
321
 
# File 'ec2/cfn_network_insights_analysis.rb', line 319

def network_insights_path_id()
  jsii_get_property("networkInsightsPathId")
end

#network_insights_path_id=(value) ⇒ Object 



323
324
325
326
 
# File 'ec2/cfn_network_insights_analysis.rb', line 323

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



604
605
606
 
# File 'ec2/cfn_network_insights_analysis.rb', line 604

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:



611
612
613
 
# File 'ec2/cfn_network_insights_analysis.rb', line 611

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.



404
405
406
407
 
# File 'ec2/cfn_network_insights_analysis.rb', line 404

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

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


165
166
167
 
# File 'ec2/cfn_network_insights_analysis.rb', line 165

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:



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

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}) 


629
630
631
632
 
# File 'ec2/cfn_network_insights_analysis.rb', line 629

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:



639
640
641
642
643
 
# File 'ec2/cfn_network_insights_analysis.rb', line 639

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

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



648
649
650
 
# File 'ec2/cfn_network_insights_analysis.rb', line 648

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



155
156
157
 
# File 'ec2/cfn_network_insights_analysis.rb', line 155

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



312
313
314
 
# File 'ec2/cfn_network_insights_analysis.rb', line 312

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to apply.

Returns:



367
368
369
 
# File 'ec2/cfn_network_insights_analysis.rb', line 367

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



371
372
373
374
375
 
# File 'ec2/cfn_network_insights_analysis.rb', line 371

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



380
381
382
 
# File 'ec2/cfn_network_insights_analysis.rb', line 380

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}) 


202
203
204
 
# File 'ec2/cfn_network_insights_analysis.rb', line 202

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}) 


212
213
214
 
# File 'ec2/cfn_network_insights_analysis.rb', line 212

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


654
655
656
657
 
# File 'ec2/cfn_network_insights_analysis.rb', line 654

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) 


393
394
395
396
397
398
 
# File 'ec2/cfn_network_insights_analysis.rb', line 393

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