Module: AWSCDK::Synthetics::ICanary

Includes:
IResource, Interfaces::AWSSynthetics::ICanaryRef
Included in:
Canary
Defined in:
synthetics/i_canary.rb

Overview

Represents a CloudWatch Synthetics Canary.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'synthetics/i_canary.rb', line 100

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :canary_ref => { kind: :property, name: "canaryRef", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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



95
96
97
98
 
# File 'synthetics/i_canary.rb', line 95

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

#canary_arn ⇒ String

The ARN of the canary.

Returns:

  • (String) 


48
49
50
 
# File 'synthetics/i_canary.rb', line 48

def canary_arn()
  jsii_get_property("canaryArn")
end

#canary_id ⇒ String

The ID of the canary.

For imported canaries, this may be the canary name as a fallback, since the actual ID (a UUID) is not available when importing by name.

Returns:

  • (String) 


58
59
60
 
# File 'synthetics/i_canary.rb', line 58

def canary_id()
  jsii_get_property("canaryId")
end

#canary_name ⇒ String

The name of the canary.

Returns:

  • (String) 


65
66
67
 
# File 'synthetics/i_canary.rb', line 65

def canary_name()
  jsii_get_property("canaryName")
end

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

A reference to a Canary resource.

Returns:



41
42
43
 
# File 'synthetics/i_canary.rb', line 41

def canary_ref()
  jsii_get_property("canaryRef")
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:



27
28
29
 
# File 'synthetics/i_canary.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'synthetics/i_canary.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'synthetics/i_canary.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



76
77
78
79
80
81
 
# File 'synthetics/i_canary.rb', line 76

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