Class: AWSCDK::Scheduler::ScheduleGroup
- Inherits:
-
Resource
- Object
- Resource
- AWSCDK::Scheduler::ScheduleGroup
- Includes:
- IScheduleGroup
- Defined in:
- scheduler/schedule_group.rb
Overview
A Schedule Group.
Class Method Summary collapse
-
.from_default_schedule_group(scope, id) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import a default schedule group.
-
.from_schedule_group_arn(scope, id, schedule_group_arn) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import an external schedule group by ARN.
-
.from_schedule_group_name(scope, id, schedule_group_name) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import an existing schedule group with a given name.
- .jsii_overridable_methods ⇒ Object
-
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
Instance Method Summary collapse
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
-
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
- #generate_physical_name ⇒ String
-
#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). -
#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). -
#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant
Grant the indicated permissions on this schedule group to the given principal [disable-awslint:no-grants].
-
#grant_delete_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant delete schedule permission for schedules in this group to the given principal.
-
#grant_read_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant list and get schedule permissions for schedules in this group to the given principal.
-
#grant_write_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant create and update schedule permissions for schedules in this group to the given principal.
-
#grants ⇒ AWSCDK::Scheduler::ScheduleGroupGrants
Collection of grant methods for a ScheduleGroup.
-
#initialize(scope, id, props = nil) ⇒ ScheduleGroup
constructor
A new instance of ScheduleGroup.
-
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return the given named metric for this schedule group.
-
#metric_attempts(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for all invocation attempts.
-
#metric_dropped(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
-
#metric_failed_to_be_sent_to_dlq(error_code = nil, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for failed invocations that also failed to deliver to DLQ.
-
#metric_sent_to_dlq(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for invocations delivered to the DLQ.
-
#metric_sent_to_dlq_truncated(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
-
#metric_target_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
-
#metric_target_throttled(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for invocation failures due to API throttling by the target.
-
#metric_throttled(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Metric for the number of invocations that were throttled because it exceeds your service quotas.
-
#node ⇒ Constructs::Node
The tree node.
-
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
-
#schedule_group_arn ⇒ String
The arn of the schedule group.
-
#schedule_group_name ⇒ String
The name of the schedule group.
-
#schedule_group_ref ⇒ AWSCDK::Interfaces::AWSScheduler::ScheduleGroupReference
A reference to a ScheduleGroup resource.
-
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props = nil) ⇒ ScheduleGroup
Returns a new instance of ScheduleGroup.
12 13 14 15 16 17 18 |
# File 'scheduler/schedule_group.rb', line 12 def initialize(scope, id, props = nil) props = props.is_a?(Hash) ? ::AWSCDK::Scheduler::ScheduleGroupProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLlNjaGVkdWxlR3JvdXBQcm9wcyJ9")), "props") unless props.nil? Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.from_default_schedule_group(scope, id) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import a default schedule group.
58 59 60 61 62 |
# File 'scheduler/schedule_group.rb', line 58 def self.from_default_schedule_group(scope, id) 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::Kernel.instance.call_static("aws-cdk-lib.aws_scheduler.ScheduleGroup", "fromDefaultScheduleGroup", [scope, id]) end |
.from_schedule_group_arn(scope, id, schedule_group_arn) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import an external schedule group by ARN.
70 71 72 73 74 75 |
# File 'scheduler/schedule_group.rb', line 70 def self.from_schedule_group_arn(scope, id, schedule_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(schedule_group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleGroupArn") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_scheduler.ScheduleGroup", "fromScheduleGroupArn", [scope, id, schedule_group_arn]) end |
.from_schedule_group_name(scope, id, schedule_group_name) ⇒ AWSCDK::Scheduler::IScheduleGroup
Import an existing schedule group with a given name.
83 84 85 86 87 88 |
# File 'scheduler/schedule_group.rb', line 83 def self.from_schedule_group_name(scope, id, schedule_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(schedule_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleGroupName") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_scheduler.ScheduleGroup", "fromScheduleGroupName", [scope, id, schedule_group_name]) end |
.jsii_overridable_methods ⇒ Object
20 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 47 48 49 50 51 |
# File 'scheduler/schedule_group.rb', line 20 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 }, :grants => { kind: :property, name: "grants", is_optional: false }, :schedule_group_arn => { kind: :property, name: "scheduleGroupArn", is_optional: false }, :schedule_group_name => { kind: :property, name: "scheduleGroupName", is_optional: false }, :schedule_group_ref => { kind: :property, name: "scheduleGroupRef", 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 }, :grant => { kind: :method, name: "grant", is_optional: false }, :grant_delete_schedules => { kind: :method, name: "grantDeleteSchedules", is_optional: false }, :grant_read_schedules => { kind: :method, name: "grantReadSchedules", is_optional: false }, :grant_write_schedules => { kind: :method, name: "grantWriteSchedules", is_optional: false }, :metric => { kind: :method, name: "metric", is_optional: false }, :metric_attempts => { kind: :method, name: "metricAttempts", is_optional: false }, :metric_dropped => { kind: :method, name: "metricDropped", is_optional: false }, :metric_failed_to_be_sent_to_dlq => { kind: :method, name: "metricFailedToBeSentToDLQ", is_optional: false }, :metric_sent_to_dlq => { kind: :method, name: "metricSentToDLQ", is_optional: false }, :metric_sent_to_dlq_truncated => { kind: :method, name: "metricSentToDLQTruncated", is_optional: false }, :metric_target_errors => { kind: :method, name: "metricTargetErrors", is_optional: false }, :metric_target_throttled => { kind: :method, name: "metricTargetThrottled", is_optional: false }, :metric_throttled => { kind: :method, name: "metricThrottled", is_optional: false }, } end |
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
136 137 138 |
# File 'scheduler/schedule_group.rb', line 136 def self.PROPERTY_INJECTION_ID() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_scheduler.ScheduleGroup", "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.
201 202 203 204 |
# File 'scheduler/schedule_group.rb', line 201 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).
218 219 220 221 |
# File 'scheduler/schedule_group.rb', line 218 def apply_removal_policy(policy) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") jsii_call_method("applyRemovalPolicy", [policy]) 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.
108 109 110 |
# File 'scheduler/schedule_group.rb', line 108 def env() jsii_get_property("env") end |
#generate_physical_name ⇒ String
224 225 226 |
# File 'scheduler/schedule_group.rb', line 224 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.
238 239 240 241 242 243 |
# File 'scheduler/schedule_group.rb', line 238 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.
253 254 255 256 |
# File 'scheduler/schedule_group.rb', line 253 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 |
#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant
Grant the indicated permissions on this schedule group to the given principal [disable-awslint:no-grants].
263 264 265 266 267 268 269 |
# File 'scheduler/schedule_group.rb', line 263 def grant(grantee, *actions) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") actions.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]") end jsii_call_method("grant", [grantee, *actions]) end |
#grant_delete_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant delete schedule permission for schedules in this group to the given principal.
The use of this method is discouraged. Please use grants.deleteSchedules() instead.
[disable-awslint:no-grants]
279 280 281 282 |
# File 'scheduler/schedule_group.rb', line 279 def grant_delete_schedules(identity) Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity") jsii_call_method("grantDeleteSchedules", [identity]) end |
#grant_read_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant list and get schedule permissions for schedules in this group to the given principal.
The use of this method is discouraged. Please use grants.readSchedules() instead.
[disable-awslint:no-grants]
292 293 294 295 |
# File 'scheduler/schedule_group.rb', line 292 def grant_read_schedules(identity) Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity") jsii_call_method("grantReadSchedules", [identity]) end |
#grant_write_schedules(identity) ⇒ AWSCDK::IAM::Grant
Grant create and update schedule permissions for schedules in this group to the given principal.
The use of this method is discouraged. Please use grants.writeSchedules() instead.
[disable-awslint:no-grants]
305 306 307 308 |
# File 'scheduler/schedule_group.rb', line 305 def grant_write_schedules(identity) Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity") jsii_call_method("grantWriteSchedules", [identity]) end |
#grants ⇒ AWSCDK::Scheduler::ScheduleGroupGrants
Collection of grant methods for a ScheduleGroup.
143 144 145 |
# File 'scheduler/schedule_group.rb', line 143 def grants() jsii_get_property("grants") end |
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Return the given named metric for this schedule group.
316 317 318 319 320 321 |
# File 'scheduler/schedule_group.rb', line 316 def metric(metric_name, props = nil) Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName") props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metric", [metric_name, props]) end |
#metric_attempts(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for all invocation attempts.
328 329 330 331 332 |
# File 'scheduler/schedule_group.rb', line 328 def metric_attempts(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricAttempts", [props]) end |
#metric_dropped(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
339 340 341 342 343 |
# File 'scheduler/schedule_group.rb', line 339 def metric_dropped(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricDropped", [props]) end |
#metric_failed_to_be_sent_to_dlq(error_code = nil, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for failed invocations that also failed to deliver to DLQ.
351 352 353 354 355 356 |
# File 'scheduler/schedule_group.rb', line 351 def metric_failed_to_be_sent_to_dlq(error_code = nil, props = nil) Jsii::Type.check_type(error_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "errorCode") unless error_code.nil? props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricFailedToBeSentToDLQ", [error_code, props]) end |
#metric_sent_to_dlq(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for invocations delivered to the DLQ.
363 364 365 366 367 |
# File 'scheduler/schedule_group.rb', line 363 def metric_sent_to_dlq(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricSentToDLQ", [props]) end |
#metric_sent_to_dlq_truncated(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
374 375 376 377 378 |
# File 'scheduler/schedule_group.rb', line 374 def metric_sent_to_dlq_truncated(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricSentToDLQTruncated", [props]) end |
#metric_target_errors(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
385 386 387 388 389 |
# File 'scheduler/schedule_group.rb', line 385 def metric_target_errors(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricTargetErrors", [props]) end |
#metric_target_throttled(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for invocation failures due to API throttling by the target.
396 397 398 399 400 |
# File 'scheduler/schedule_group.rb', line 396 def metric_target_throttled(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricTargetThrottled", [props]) end |
#metric_throttled(props = nil) ⇒ AWSCDK::CloudWatch::Metric
Default: - sum over 5 minutes
Metric for the number of invocations that were throttled because it exceeds your service quotas.
408 409 410 411 412 |
# File 'scheduler/schedule_group.rb', line 408 def metric_throttled(props = nil) props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil? jsii_call_method("metricThrottled", [props]) end |
#node ⇒ Constructs::Node
The tree node.
93 94 95 |
# File 'scheduler/schedule_group.rb', line 93 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.
122 123 124 |
# File 'scheduler/schedule_group.rb', line 122 def physical_name() jsii_get_property("physicalName") end |
#schedule_group_arn ⇒ String
The arn of the schedule group.
150 151 152 |
# File 'scheduler/schedule_group.rb', line 150 def schedule_group_arn() jsii_get_property("scheduleGroupArn") end |
#schedule_group_name ⇒ String
The name of the schedule group.
157 158 159 |
# File 'scheduler/schedule_group.rb', line 157 def schedule_group_name() jsii_get_property("scheduleGroupName") end |
#schedule_group_ref ⇒ AWSCDK::Interfaces::AWSScheduler::ScheduleGroupReference
A reference to a ScheduleGroup resource.
164 165 166 |
# File 'scheduler/schedule_group.rb', line 164 def schedule_group_ref() jsii_get_property("scheduleGroupRef") end |
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
129 130 131 |
# File 'scheduler/schedule_group.rb', line 129 def stack() jsii_get_property("stack") end |
#to_string ⇒ String
Returns a string representation of this construct.
171 172 173 |
# File 'scheduler/schedule_group.rb', line 171 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.
184 185 186 187 188 189 |
# File 'scheduler/schedule_group.rb', line 184 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 |