Class: AWSCDK::InternetMonitor::CfnMonitor

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSInternetmonitor::IMonitorRef
Defined in:
internet_monitor/cfn_monitor.rb

Overview

The AWS::InternetMonitor::Monitor resource is an Internet Monitor resource type that contains information about how you create a monitor in Amazon CloudWatch Internet Monitor.

A monitor in Internet Monitor provides visibility into performance and availability between your applications hosted on AWS and your end users, using a traffic profile that it creates based on the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories.

Internet Monitor also alerts you to internet issues that impact your application in the city-networks (geographies and networks) where your end users use it. With Internet Monitor, you can quickly pinpoint the locations and providers that are affected, so that you can address the issue.

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMonitor

Create a new AWS::InternetMonitor::Monitor.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::InternetMonitor::CfnMonitorProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'internet_monitor/cfn_monitor.rb', line 24

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

Class Method Details

.arn_for_monitor(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'internet_monitor/cfn_monitor.rb', line 93

def self.arn_for_monitor(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbnRlcm5ldG1vbml0b3IuSU1vbml0b3JSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_internetmonitor.CfnMonitor", "arnForMonitor", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


226
227
228
 
# File 'internet_monitor/cfn_monitor.rb', line 226

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

.from_monitor_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSInternetmonitor::IMonitorRef

Creates a new IMonitorRef from an ARN.

Parameters:

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

Returns:



104
105
106
107
108
109
 
# File 'internet_monitor/cfn_monitor.rb', line 104

def self.from_monitor_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_internetmonitor.CfnMonitor", "fromMonitorArn", [scope, id, arn])
end

.from_monitor_name(scope, id, monitor_name) ⇒ AWSCDK::Interfaces::AWSInternetmonitor::IMonitorRef

Creates a new IMonitorRef from a monitorName.

Parameters:

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

Returns:



117
118
119
120
121
122
 
# File 'internet_monitor/cfn_monitor.rb', line 117

def self.from_monitor_name(scope, id, monitor_name)
  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(monitor_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "monitorName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_internetmonitor.CfnMonitor", "fromMonitorName", [scope, id, monitor_name])
end

.is_cfn_monitor(x) ⇒ Boolean

Checks whether the given object is a CfnMonitor.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


128
129
130
131
 
# File 'internet_monitor/cfn_monitor.rb', line 128

def self.is_cfn_monitor(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_internetmonitor.CfnMonitor", "isCfnMonitor", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'internet_monitor/cfn_monitor.rb', line 32

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_monitor_arn => { kind: :property, name: "attrMonitorArn", is_optional: false },
    :attr_processing_status => { kind: :property, name: "attrProcessingStatus", is_optional: false },
    :attr_processing_status_info => { kind: :property, name: "attrProcessingStatusInfo", is_optional: false },
    :monitor_ref => { kind: :property, name: "monitorRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :monitor_name => { kind: :property, name: "monitorName", is_optional: false },
    :health_events_config => { kind: :property, name: "healthEventsConfig", is_optional: true },
    :include_linked_accounts => { kind: :property, name: "includeLinkedAccounts", is_optional: true },
    :internet_measurements_log_delivery => { kind: :property, name: "internetMeasurementsLogDelivery", is_optional: true },
    :linked_account_id => { kind: :property, name: "linkedAccountId", is_optional: true },
    :max_city_networks_to_monitor => { kind: :property, name: "maxCityNetworksToMonitor", is_optional: true },
    :resources => { kind: :property, name: "resources", is_optional: true },
    :resources_to_add => { kind: :property, name: "resourcesToAdd", is_optional: true },
    :resources_to_remove => { kind: :property, name: "resourcesToRemove", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :traffic_percentage_to_monitor => { kind: :property, name: "trafficPercentageToMonitor", 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.



464
465
466
467
 
# File 'internet_monitor/cfn_monitor.rb', line 464

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:



476
477
478
479
 
# File 'internet_monitor/cfn_monitor.rb', line 476

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:



486
487
488
489
 
# File 'internet_monitor/cfn_monitor.rb', line 486

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:



497
498
499
500
501
 
# File 'internet_monitor/cfn_monitor.rb', line 497

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.


554
555
556
557
558
 
# File 'internet_monitor/cfn_monitor.rb', line 554

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.



564
565
566
567
 
# File 'internet_monitor/cfn_monitor.rb', line 564

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.



576
577
578
579
580
 
# File 'internet_monitor/cfn_monitor.rb', line 576

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:



589
590
591
592
 
# File 'internet_monitor/cfn_monitor.rb', line 589

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:



611
612
613
614
615
616
 
# File 'internet_monitor/cfn_monitor.rb', line 611

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_created_at ⇒ String

The time when the monitor was created.

Returns:

  • (String) 


233
234
235
 
# File 'internet_monitor/cfn_monitor.rb', line 233

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_modified_at ⇒ String

The last time that the monitor was modified.

Returns:

  • (String) 


240
241
242
 
# File 'internet_monitor/cfn_monitor.rb', line 240

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_monitor_arn ⇒ String

The Amazon Resource Name (ARN) of the monitor.

Returns:

  • (String) 


247
248
249
 
# File 'internet_monitor/cfn_monitor.rb', line 247

def attr_monitor_arn()
  jsii_get_property("attrMonitorArn")
end

#attr_processing_status ⇒ String

The health of data processing for the monitor.

For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .

Returns:

  • (String) 


256
257
258
 
# File 'internet_monitor/cfn_monitor.rb', line 256

def attr_processing_status()
  jsii_get_property("attrProcessingStatus")
end

#attr_processing_status_info ⇒ String

Additional information about the health of the data processing for the monitor.

Returns:

  • (String) 


263
264
265
 
# File 'internet_monitor/cfn_monitor.rb', line 263

def attr_processing_status_info()
  jsii_get_property("attrProcessingStatusInfo")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



179
180
181
 
# File 'internet_monitor/cfn_monitor.rb', line 179

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'internet_monitor/cfn_monitor.rb', line 184

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


620
621
622
623
 
# File 'internet_monitor/cfn_monitor.rb', line 620

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


189
190
191
 
# File 'internet_monitor/cfn_monitor.rb', line 189

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


196
197
198
 
# File 'internet_monitor/cfn_monitor.rb', line 196

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


141
142
143
 
# File 'internet_monitor/cfn_monitor.rb', line 141

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



201
202
203
 
# File 'internet_monitor/cfn_monitor.rb', line 201

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:



633
634
635
636
637
 
# File 'internet_monitor/cfn_monitor.rb', line 633

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:



644
645
646
647
 
# File 'internet_monitor/cfn_monitor.rb', line 644

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

#health_events_config ⇒ AWSCDK::IResolvable, ...

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

Returns:



296
297
298
 
# File 'internet_monitor/cfn_monitor.rb', line 296

def health_events_config()
  jsii_get_property("healthEventsConfig")
end

#health_events_config=(value) ⇒ Object 



300
301
302
303
304
 
# File 'internet_monitor/cfn_monitor.rb', line 300

def health_events_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::InternetMonitor::CfnMonitor::HealthEventsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbnRlcm5ldG1vbml0b3IuQ2ZuTW9uaXRvci5IZWFsdGhFdmVudHNDb25maWdQcm9wZXJ0eSJ9XX19")), "healthEventsConfig") unless value.nil?
  jsii_set_property("healthEventsConfig", value)
end

#include_linked_accounts ⇒ Boolean, ...

A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor.

Returns:



309
310
311
 
# File 'internet_monitor/cfn_monitor.rb', line 309

def include_linked_accounts()
  jsii_get_property("includeLinkedAccounts")
end

#include_linked_accounts=(value) ⇒ Object 



313
314
315
316
 
# File 'internet_monitor/cfn_monitor.rb', line 313

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



714
715
716
717
 
# File 'internet_monitor/cfn_monitor.rb', line 714

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

#internet_measurements_log_delivery ⇒ AWSCDK::IResolvable, ...

Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket.

Returns:



321
322
323
 
# File 'internet_monitor/cfn_monitor.rb', line 321

def internet_measurements_log_delivery()
  jsii_get_property("internetMeasurementsLogDelivery")
end

#internet_measurements_log_delivery=(value) ⇒ Object 



325
326
327
328
329
 
# File 'internet_monitor/cfn_monitor.rb', line 325

def internet_measurements_log_delivery=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::InternetMonitor::CfnMonitor::InternetMeasurementsLogDeliveryProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbnRlcm5ldG1vbml0b3IuQ2ZuTW9uaXRvci5JbnRlcm5ldE1lYXN1cmVtZW50c0xvZ0RlbGl2ZXJ5UHJvcGVydHkifV19fQ==")), "internetMeasurementsLogDelivery") unless value.nil?
  jsii_set_property("internetMeasurementsLogDelivery", value)
end

#linked_account_id ⇒ String?

The account ID for an account that you've set up cross-account sharing for in Internet Monitor.

Returns:

  • (String, nil) 


334
335
336
 
# File 'internet_monitor/cfn_monitor.rb', line 334

def ()
  jsii_get_property("linkedAccountId")
end

#linked_account_id=(value) ⇒ Object 



338
339
340
341
 
# File 'internet_monitor/cfn_monitor.rb', line 338

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


153
154
155
 
# File 'internet_monitor/cfn_monitor.rb', line 153

def logical_id()
  jsii_get_property("logicalId")
end

#max_city_networks_to_monitor ⇒ Numeric?

The maximum number of city-networks to monitor for your resources.

Returns:

  • (Numeric, nil) 


346
347
348
 
# File 'internet_monitor/cfn_monitor.rb', line 346

def max_city_networks_to_monitor()
  jsii_get_property("maxCityNetworksToMonitor")
end

#max_city_networks_to_monitor=(value) ⇒ Object 



350
351
352
353
 
# File 'internet_monitor/cfn_monitor.rb', line 350

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

#monitor_name ⇒ String

The name of the monitor.

Returns:

  • (String) 


284
285
286
 
# File 'internet_monitor/cfn_monitor.rb', line 284

def monitor_name()
  jsii_get_property("monitorName")
end

#monitor_name=(value) ⇒ Object 



288
289
290
291
 
# File 'internet_monitor/cfn_monitor.rb', line 288

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

#monitor_ref ⇒ AWSCDK::Interfaces::AWSInternetmonitor::MonitorReference

A reference to a Monitor resource.

Returns:



270
271
272
 
# File 'internet_monitor/cfn_monitor.rb', line 270

def monitor_ref()
  jsii_get_property("monitorRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


136
137
138
 
# File 'internet_monitor/cfn_monitor.rb', line 136

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:



655
656
657
 
# File 'internet_monitor/cfn_monitor.rb', line 655

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:



662
663
664
 
# File 'internet_monitor/cfn_monitor.rb', line 662

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.



455
456
457
458
 
# File 'internet_monitor/cfn_monitor.rb', line 455

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) 


172
173
174
 
# File 'internet_monitor/cfn_monitor.rb', line 172

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:



673
674
675
676
 
# File 'internet_monitor/cfn_monitor.rb', line 673

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


680
681
682
683
 
# File 'internet_monitor/cfn_monitor.rb', line 680

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:



690
691
692
693
694
 
# File 'internet_monitor/cfn_monitor.rb', line 690

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

#resources ⇒ Array<String>?

The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).

Returns:

  • (Array<String>, nil) 


358
359
360
 
# File 'internet_monitor/cfn_monitor.rb', line 358

def resources()
  jsii_get_property("resources")
end

#resources=(value) ⇒ Object 



362
363
364
365
 
# File 'internet_monitor/cfn_monitor.rb', line 362

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

#resources_to_add ⇒ Array<String>?

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

Returns:

  • (Array<String>, nil) 


370
371
372
 
# File 'internet_monitor/cfn_monitor.rb', line 370

def resources_to_add()
  jsii_get_property("resourcesToAdd")
end

#resources_to_add=(value) ⇒ Object 



374
375
376
377
 
# File 'internet_monitor/cfn_monitor.rb', line 374

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

#resources_to_remove ⇒ Array<String>?

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

Returns:

  • (Array<String>, nil) 


382
383
384
 
# File 'internet_monitor/cfn_monitor.rb', line 382

def resources_to_remove()
  jsii_get_property("resourcesToRemove")
end

#resources_to_remove=(value) ⇒ Object 



386
387
388
389
 
# File 'internet_monitor/cfn_monitor.rb', line 386

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



699
700
701
 
# File 'internet_monitor/cfn_monitor.rb', line 699

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:



162
163
164
 
# File 'internet_monitor/cfn_monitor.rb', line 162

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of a monitor.

Returns:

  • (String, nil) 


394
395
396
 
# File 'internet_monitor/cfn_monitor.rb', line 394

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



398
399
400
401
 
# File 'internet_monitor/cfn_monitor.rb', line 398

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



277
278
279
 
# File 'internet_monitor/cfn_monitor.rb', line 277

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for a monitor, listed as a set of key:value pairs.

Returns:



406
407
408
 
# File 'internet_monitor/cfn_monitor.rb', line 406

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



410
411
412
413
414
 
# File 'internet_monitor/cfn_monitor.rb', line 410

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



431
432
433
 
# File 'internet_monitor/cfn_monitor.rb', line 431

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

#traffic_percentage_to_monitor ⇒ Numeric?

The percentage of the internet-facing traffic for your application that you want to monitor.

Returns:

  • (Numeric, nil) 


419
420
421
 
# File 'internet_monitor/cfn_monitor.rb', line 419

def traffic_percentage_to_monitor()
  jsii_get_property("trafficPercentageToMonitor")
end

#traffic_percentage_to_monitor=(value) ⇒ Object 



423
424
425
426
 
# File 'internet_monitor/cfn_monitor.rb', line 423

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


209
210
211
 
# File 'internet_monitor/cfn_monitor.rb', line 209

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


219
220
221
 
# File 'internet_monitor/cfn_monitor.rb', line 219

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


705
706
707
708
 
# File 'internet_monitor/cfn_monitor.rb', line 705

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) 


444
445
446
447
448
449
 
# File 'internet_monitor/cfn_monitor.rb', line 444

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