Class: AWSCDK::Synthetics::Group

Inherits:
Resource
  • Object
show all
Includes:
IGroup
Defined in:
synthetics/group.rb

Overview

Define a new CloudWatch Synthetics Group.

Groups allow you to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ Group

Returns a new instance of Group.

Parameters:



16
17
18
19
20
21
22
 
# File 'synthetics/group.rb', line 16

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

Class Method Details

.from_group_arn(scope, id, group_arn) ⇒ AWSCDK::Synthetics::IGroup

Import an existing group by ARN.

Parameters:

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

Returns:



52
53
54
55
56
57
 
# File 'synthetics/group.rb', line 52

def self.from_group_arn(scope, id, group_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(group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Group", "fromGroupArn", [scope, id, group_arn])
end

.from_group_name(scope, id, group_name) ⇒ AWSCDK::Synthetics::IGroup

Import an existing group by name.

Parameters:

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

Returns:



65
66
67
68
69
70
 
# File 'synthetics/group.rb', line 65

def self.from_group_name(scope, id, group_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(group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_synthetics.Group", "fromGroupName", [scope, id, group_name])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :canaries => { kind: :property, name: "canaries", is_optional: false },
    :group_arn => { kind: :property, name: "groupArn", is_optional: false },
    :group_id => { kind: :property, name: "groupId", is_optional: false },
    :group_name => { kind: :property, name: "groupName", is_optional: false },
    :group_ref => { kind: :property, name: "groupRef", 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 },
    :add_canary => { kind: :method, name: "addCanary", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


118
119
120
 
# File 'synthetics/group.rb', line 118

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

Instance Method Details

#add_canary(canary) ⇒ void

This method returns an undefined value.

Add a canary to this group.

Parameters:



251
252
253
254
 
# File 'synthetics/group.rb', line 251

def add_canary(canary)
  Jsii::Type.check_type(canary, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3ludGhldGljcy5JQ2FuYXJ5In0=")), "canary")
  jsii_call_method("addCanary", [canary])
end

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



190
191
192
193
 
# File 'synthetics/group.rb', line 190

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:



207
208
209
210
 
# File 'synthetics/group.rb', line 207

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

#canaries ⇒ Array<AWSCDK::Synthetics::ICanary>

Get all canaries associated with this group.

Returns:



125
126
127
 
# File 'synthetics/group.rb', line 125

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



90
91
92
 
# File 'synthetics/group.rb', line 90

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


213
214
215
 
# File 'synthetics/group.rb', line 213

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) 


227
228
229
230
231
232
 
# File 'synthetics/group.rb', line 227

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) 


242
243
244
245
 
# File 'synthetics/group.rb', line 242

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

#group_arn ⇒ String

The ARN of the group.

Returns:

  • (String) 


132
133
134
 
# File 'synthetics/group.rb', line 132

def group_arn()
  jsii_get_property("groupArn")
end

#group_id ⇒ String

The ID of the group.

Returns:

  • (String) 


139
140
141
 
# File 'synthetics/group.rb', line 139

def group_id()
  jsii_get_property("groupId")
end

#group_name ⇒ String

The name of the group.

Returns:

  • (String) 


146
147
148
 
# File 'synthetics/group.rb', line 146

def group_name()
  jsii_get_property("groupName")
end

#group_ref ⇒ AWSCDK::Interfaces::AWSSynthetics::GroupReference

A reference to the group.

Returns:



153
154
155
 
# File 'synthetics/group.rb', line 153

def group_ref()
  jsii_get_property("groupRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


75
76
77
 
# File 'synthetics/group.rb', line 75

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) 


104
105
106
 
# File 'synthetics/group.rb', line 104

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



111
112
113
 
# File 'synthetics/group.rb', line 111

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


160
161
162
 
# File 'synthetics/group.rb', line 160

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) 


173
174
175
176
177
178
 
# File 'synthetics/group.rb', line 173

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