Class: AWSCDK::Synthetics::Canary

Inherits:
Resource
  • Object
show all
Includes:
EC2::IConnectable, ICanary
Defined in:
synthetics/canary.rb

Overview

Define a new Canary.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Canary

Returns a new instance of Canary.

Parameters:



13
14
15
16
17
18
19
 
# File 'synthetics/canary.rb', line 13

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

Class Method Details

.from_canary_arn(scope, id, canary_arn) ⇒ AWSCDK::Synthetics::ICanary

Import an existing canary by ARN.

Parameters:

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

Returns:



54
55
56
57
58
59
 
# File 'synthetics/canary.rb', line 54

def self.from_canary_arn(scope, id, canary_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(canary_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "canaryArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Canary", "fromCanaryArn", [scope, id, canary_arn])
end

.from_canary_name(scope, id, canary_name) ⇒ AWSCDK::Synthetics::ICanary

Import an existing canary by name.

Parameters:

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

Returns:



67
68
69
70
71
72
 
# File 'synthetics/canary.rb', line 67

def self.from_canary_name(scope, id, canary_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(canary_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "canaryName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Canary", "fromCanaryName", [scope, id, canary_name])
end

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :artifacts_bucket => { kind: :property, name: "artifactsBucket", is_optional: false },
    :canary_arn => { kind: :property, name: "canaryArn", is_optional: false },
    :canary_id => { kind: :property, name: "canaryId", is_optional: false },
    :canary_name => { kind: :property, name: "canaryName", is_optional: false },
    :canary_ref => { kind: :property, name: "canaryRef", is_optional: false },
    :canary_state => { kind: :property, name: "canaryState", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :metric_duration => { kind: :method, name: "metricDuration", is_optional: false },
    :metric_failed => { kind: :method, name: "metricFailed", is_optional: false },
    :metric_success_percent => { kind: :method, name: "metricSuccessPercent", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


120
121
122
 
# File 'synthetics/canary.rb', line 120

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

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

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

Parameters:



217
218
219
220
 
# File 'synthetics/canary.rb', line 217

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

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

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

Parameters:



234
235
236
237
 
# File 'synthetics/canary.rb', line 234

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

#artifacts_bucket ⇒ AWSCDK::S3::IBucket

Bucket where data from each canary run is stored.

Returns:



127
128
129
 
# File 'synthetics/canary.rb', line 127

def artifacts_bucket()
  jsii_get_property("artifactsBucket")
end

#canary_arn ⇒ String

The canary ARN.

Returns:

  • (String) 


134
135
136
 
# File 'synthetics/canary.rb', line 134

def canary_arn()
  jsii_get_property("canaryArn")
end

#canary_id ⇒ String

The canary ID.

Returns:

  • (String) 


141
142
143
 
# File 'synthetics/canary.rb', line 141

def canary_id()
  jsii_get_property("canaryId")
end

#canary_name ⇒ String

The canary Name.

Returns:

  • (String) 


148
149
150
 
# File 'synthetics/canary.rb', line 148

def canary_name()
  jsii_get_property("canaryName")
end

#canary_ref ⇒ AWSCDK::Interfaces::AWSSynthetics::CanaryReference

A reference to the canary.

Returns:



155
156
157
 
# File 'synthetics/canary.rb', line 155

def canary_ref()
  jsii_get_property("canaryRef")
end

#canary_state ⇒ String

The state of the canary.

For example, 'RUNNING', 'STOPPED', 'NOT STARTED', or 'ERROR'.

Returns:

  • (String) 


164
165
166
 
# File 'synthetics/canary.rb', line 164

def canary_state()
  jsii_get_property("canaryState")
end

#connections ⇒ AWSCDK::EC2::Connections

Access the Connections object.

Will fail if not a VPC-enabled Canary

Returns:



173
174
175
 
# File 'synthetics/canary.rb', line 173

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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

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

Returns:



92
93
94
 
# File 'synthetics/canary.rb', line 92

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


240
241
242
 
# File 'synthetics/canary.rb', line 240

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

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

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

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

Parameters:

  • arn_attr (String) —

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

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


254
255
256
257
258
259
 
# File 'synthetics/canary.rb', line 254

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

#get_resource_name_attribute(name_attr) ⇒ String

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

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

Parameters:

  • name_attr (String) —

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

Returns:

  • (String) 


269
270
271
272
 
# File 'synthetics/canary.rb', line 269

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

#metric_duration(options = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: avg over 5 minutes

Measure the Duration of a single canary run, in seconds.

Parameters:

Returns:



279
280
281
282
283
 
# File 'synthetics/canary.rb', line 279

def metric_duration(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("metricDuration", [options])
end

#metric_failed(options = nil) ⇒ AWSCDK::CloudWatch::Metric

Measure the number of failed canary runs over a given time period.

Default: sum over 5 minutes

Parameters:

Returns:



291
292
293
294
295
 
# File 'synthetics/canary.rb', line 291

def metric_failed(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("metricFailed", [options])
end

#metric_success_percent(options = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: avg over 5 minutes

Measure the percentage of successful canary runs.

Parameters:

Returns:



302
303
304
305
306
 
# File 'synthetics/canary.rb', line 302

def metric_success_percent(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("metricSuccessPercent", [options])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


77
78
79
 
# File 'synthetics/canary.rb', line 77

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

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

This value will resolve to one of the following:

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

Returns:

  • (String) 


106
107
108
 
# File 'synthetics/canary.rb', line 106

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole

Execution role associated with this Canary.

Returns:



180
181
182
 
# File 'synthetics/canary.rb', line 180

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



113
114
115
 
# File 'synthetics/canary.rb', line 113

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


187
188
189
 
# File 'synthetics/canary.rb', line 187

def to_string()
  jsii_call_method("toString", [])
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) 


200
201
202
203
204
205
 
# File 'synthetics/canary.rb', line 200

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