Class: AWSCDK::Synthetics::Code

Inherits:

Jsii::Object

• Object
• Jsii::Object
• AWSCDK::Synthetics::Code

Defined in:

synthetics/code.rb

Overview

The code the canary should execute.

Direct Known Subclasses

AssetCode, InlineCode, S3Code

Class Method Summary

• .from_asset(asset_path, options = nil) ⇒ AWSCDK::Synthetics::AssetCode

  Specify code from a local path.

• .from_bucket(bucket, key, object_version = nil) ⇒ AWSCDK::Synthetics::S3Code

  Specify code from an s3 bucket.

• .from_inline(code) ⇒ AWSCDK::Synthetics::InlineCode

  Specify code inline.

• .jsii_overridable_methods ⇒ Object

Instance Method Summary

• #bind(scope, handler, family, runtime_name = nil) ⇒ AWSCDK::Synthetics::CodeConfig

  Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.

• #initialize ⇒ Code constructor

  A new instance of Code.

Constructor Details

#initialize ⇒ Code

Returns a new instance of Code.

# File 'synthetics/code.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_asset(asset_path, options = nil) ⇒ AWSCDK::Synthetics::AssetCode

Specify code from a local path.

Path must include the folder structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

• asset_path (String) —

  Either a directory or a .zip file.

• options (AWSCDK::S3Assets::AssetOptions, nil) (defaults to: nil)

Returns:

• (AWSCDK::Synthetics::AssetCode) —

  AssetCode associated with the specified path.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

# File 'synthetics/code.rb', line 26

def self.from_asset(asset_path, options = nil)
  Jsii::Type.check_type(asset_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assetPath")
  options = options.is_a?(Hash) ? ::AWSCDK::S3Assets::AssetOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczNfYXNzZXRzLkFzc2V0T3B0aW9ucyJ9")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Code", "fromAsset", [asset_path, options])
end

.from_bucket(bucket, key, object_version = nil) ⇒ AWSCDK::Synthetics::S3Code

Specify code from an s3 bucket.

The object in the s3 bucket must be a .zip file that contains the structure nodejs/node_modules/myCanaryFilename.js.

Parameters:

• bucket (AWSCDK::Interfaces::AWSS3::IBucketRef) —

  The S3 bucket.

• key (String) —

  The object key.

• object_version (String, nil) (defaults to: nil) —

  Optional S3 object version.

Returns:

• (AWSCDK::Synthetics::S3Code) —

  S3Code associated with the specified S3 object.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch

# File 'synthetics/code.rb', line 43

def self.from_bucket(bucket, key, object_version = nil)
  Jsii::Type.check_type(bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zMy5JQnVja2V0UmVmIn0=")), "bucket")
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(object_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectVersion") unless object_version.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Code", "fromBucket", [bucket, key, object_version])
end

.from_inline(code) ⇒ AWSCDK::Synthetics::InlineCode

Specify code inline.

Parameters:

• code (String) —

  The actual handler code (limited to 5MB).

Returns:

• (AWSCDK::Synthetics::InlineCode) —

  InlineCode with inline code.

# File 'synthetics/code.rb', line 54

def self.from_inline(code)
  Jsii::Type.check_type(code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "code")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Code", "fromInline", [code])
end

.jsii_overridable_methods ⇒ Object

# File 'synthetics/code.rb', line 12

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind(scope, handler, family, runtime_name = nil) ⇒ AWSCDK::Synthetics::CodeConfig

Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.

Parameters:

• scope (Constructs::Construct) —

  The binding scope.

• handler (String)
• family (AWSCDK::Synthetics::RuntimeFamily)
• runtime_name (String, nil) (defaults to: nil)

Returns:

• (AWSCDK::Synthetics::CodeConfig) —

  a bound CodeConfig.

# File 'synthetics/code.rb', line 66

def bind(scope, handler, family, runtime_name = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(handler, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "handler")
  Jsii::Type.check_type(family, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3ludGhldGljcy5SdW50aW1lRmFtaWx5In0=")), "family")
  Jsii::Type.check_type(runtime_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runtimeName") unless runtime_name.nil?
  jsii_call_method("bind", [scope, handler, family, runtime_name])
end