Class: AWSCDK::ECSPatterns::ScheduledEC2TaskProps

Inherits:
ScheduledTaskBaseProps
  • Object
show all
Defined in:
ecs_patterns/scheduled_ec2_task_props.rb

Overview

The properties for the ScheduledEc2Task task.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schedule:, cluster: nil, desired_task_count: nil, enabled: nil, propagate_tags: nil, rule_name: nil, security_groups: nil, subnet_selection: nil, tags: nil, vpc: nil, scheduled_ec2_task_definition_options: nil, scheduled_ec2_task_image_options: nil) ⇒ ScheduledEC2TaskProps

Returns a new instance of ScheduledEC2TaskProps.

Parameters:

  • schedule (AWSCDK::ApplicationAutoScaling::Schedule) —

    The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.

  • cluster (AWSCDK::ECS::ICluster, nil) (defaults to: nil) —

    The name of the cluster that hosts the service.

  • desired_task_count (Numeric, nil) (defaults to: nil) —

    The desired number of instantiations of the task definition to keep running on the service.

  • enabled (Boolean, nil) (defaults to: nil) —

    Indicates whether the rule is enabled.

  • propagate_tags (AWSCDK::ECS::PropagatedTagSource, nil) (defaults to: nil) —

    Specifies whether to propagate the tags from the task definition to the task.

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

    A name for the rule.

  • security_groups (Array<AWSCDK::EC2::ISecurityGroup>, nil) (defaults to: nil) —

    Existing security groups to use for your service.

  • subnet_selection (AWSCDK::EC2::SubnetSelection, nil) (defaults to: nil) —

    In what subnets to place the task's ENIs.

  • tags (Array<AWSCDK::EventsTargets::Tag>, nil) (defaults to: nil) —

    The metadata that you apply to the task to help you categorize and organize them.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

  • scheduled_ec2_task_definition_options (AWSCDK::ECSPatterns::ScheduledEC2TaskDefinitionOptions, nil) (defaults to: nil) —

    The properties to define if using an existing TaskDefinition in this construct.

  • scheduled_ec2_task_image_options (AWSCDK::ECSPatterns::ScheduledEC2TaskImageOptions, nil) (defaults to: nil) —

    The properties to define if the construct is to create a TaskDefinition.



19
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
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 19

def initialize(schedule:, cluster: nil, desired_task_count: nil, enabled: nil, propagate_tags: nil, rule_name: nil, security_groups: nil, subnet_selection: nil, tags: nil, vpc: nil, scheduled_ec2_task_definition_options: nil, scheduled_ec2_task_image_options: nil)
  @schedule = schedule
  Jsii::Type.check_type(@schedule, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbGljYXRpb25hdXRvc2NhbGluZy5TY2hlZHVsZSJ9")), "schedule")
  @cluster = cluster
  Jsii::Type.check_type(@cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLklDbHVzdGVyIn0=")), "cluster") unless @cluster.nil?
  @desired_task_count = desired_task_count
  Jsii::Type.check_type(@desired_task_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "desiredTaskCount") unless @desired_task_count.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enabled") unless @enabled.nil?
  @propagate_tags = propagate_tags
  Jsii::Type.check_type(@propagate_tags, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLlByb3BhZ2F0ZWRUYWdTb3VyY2UifQ==")), "propagateTags") unless @propagate_tags.nil?
  @rule_name = rule_name
  Jsii::Type.check_type(@rule_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleName") unless @rule_name.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSVNlY3VyaXR5R3JvdXAifSwia2luZCI6ImFycmF5In19")), "securityGroups") unless @security_groups.nil?
  @subnet_selection = subnet_selection.is_a?(Hash) ? ::AWSCDK::EC2::SubnetSelection.new(**subnet_selection.transform_keys(&:to_sym)) : subnet_selection
  Jsii::Type.check_type(@subnet_selection, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlN1Ym5ldFNlbGVjdGlvbiJ9")), "subnetSelection") unless @subnet_selection.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EventsTargets::Tag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHNfdGFyZ2V0cy5UYWcifSwia2luZCI6ImFycmF5In19")), "tags") unless @tags.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
  @scheduled_ec2_task_definition_options = scheduled_ec2_task_definition_options.is_a?(Hash) ? ::AWSCDK::ECSPatterns::ScheduledEC2TaskDefinitionOptions.new(**scheduled_ec2_task_definition_options.transform_keys(&:to_sym)) : scheduled_ec2_task_definition_options
  Jsii::Type.check_type(@scheduled_ec2_task_definition_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzX3BhdHRlcm5zLlNjaGVkdWxlZEVjMlRhc2tEZWZpbml0aW9uT3B0aW9ucyJ9")), "scheduledEc2TaskDefinitionOptions") unless @scheduled_ec2_task_definition_options.nil?
  @scheduled_ec2_task_image_options = scheduled_ec2_task_image_options.is_a?(Hash) ? ::AWSCDK::ECSPatterns::ScheduledEC2TaskImageOptions.new(**scheduled_ec2_task_image_options.transform_keys(&:to_sym)) : scheduled_ec2_task_image_options
  Jsii::Type.check_type(@scheduled_ec2_task_image_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzX3BhdHRlcm5zLlNjaGVkdWxlZEVjMlRhc2tJbWFnZU9wdGlvbnMifQ==")), "scheduledEc2TaskImageOptions") unless @scheduled_ec2_task_image_options.nil?
end

Instance Attribute Details

#cluster ⇒ AWSCDK::ECS::ICluster? (readonly)

Note:

Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

The name of the cluster that hosts the service.

If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

Returns:



60
61
62
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 60

def cluster
  @cluster
end

#desired_task_count ⇒ Numeric? (readonly)

Note:

Default: 1

The desired number of instantiations of the task definition to keep running on the service.

Returns:

  • (Numeric, nil) 


65
66
67
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 65

def desired_task_count
  @desired_task_count
end

#enabled ⇒ Boolean? (readonly)

Note:

Default: true

Indicates whether the rule is enabled.

Returns:

  • (Boolean, nil) 


70
71
72
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 70

def enabled
  @enabled
end

#propagate_tags ⇒ AWSCDK::ECS::PropagatedTagSource? (readonly)

Note:

Default: - Tags will not be propagated

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated.

Returns:



77
78
79
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 77

def propagate_tags
  @propagate_tags
end

#rule_name ⇒ String? (readonly)

Note:

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

A name for the rule.

Returns:

  • (String, nil) 


82
83
84
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 82

def rule_name
  @rule_name
end

#schedule ⇒ AWSCDK::ApplicationAutoScaling::Schedule (readonly)

The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.

For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

Returns:



53
54
55
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 53

def schedule
  @schedule
end

#scheduled_ec2_task_definition_options ⇒ AWSCDK::ECSPatterns::ScheduledEC2TaskDefinitionOptions? (readonly)

Note:

Default: none

The properties to define if using an existing TaskDefinition in this construct.

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

Returns:



115
116
117
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 115

def scheduled_ec2_task_definition_options
  @scheduled_ec2_task_definition_options
end

#scheduled_ec2_task_image_options ⇒ AWSCDK::ECSPatterns::ScheduledEC2TaskImageOptions? (readonly)

Note:

Default: none

The properties to define if the construct is to create a TaskDefinition.

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

Returns:



122
123
124
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 122

def scheduled_ec2_task_image_options
  @scheduled_ec2_task_image_options
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup>? (readonly)

Note:

Default: - a new security group will be created.

Existing security groups to use for your service.

Returns:



87
88
89
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 87

def security_groups
  @security_groups
end

#subnet_selection ⇒ AWSCDK::EC2::SubnetSelection? (readonly)

Note:

Default: Private subnets

In what subnets to place the task's ENIs.

(Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Returns:



94
95
96
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 94

def subnet_selection
  @subnet_selection
end

#tags ⇒ Array<AWSCDK::EventsTargets::Tag>? (readonly)

Note:

Default: - No tags are applied to the task

The metadata that you apply to the task to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define.

Returns:



101
102
103
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 101

def tags
  @tags
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - uses the VPC defined in the cluster or creates a new VPC.

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

Returns:



108
109
110
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 108

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 124

def self.jsii_properties
  {
    :schedule => "schedule",
    :cluster => "cluster",
    :desired_task_count => "desiredTaskCount",
    :enabled => "enabled",
    :propagate_tags => "propagateTags",
    :rule_name => "ruleName",
    :security_groups => "securityGroups",
    :subnet_selection => "subnetSelection",
    :tags => "tags",
    :vpc => "vpc",
    :scheduled_ec2_task_definition_options => "scheduledEc2TaskDefinitionOptions",
    :scheduled_ec2_task_image_options => "scheduledEc2TaskImageOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'ecs_patterns/scheduled_ec2_task_props.rb', line 141

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "schedule" => @schedule,
    "cluster" => @cluster,
    "desiredTaskCount" => @desired_task_count,
    "enabled" => @enabled,
    "propagateTags" => @propagate_tags,
    "ruleName" => @rule_name,
    "securityGroups" => @security_groups,
    "subnetSelection" => @subnet_selection,
    "tags" => @tags,
    "vpc" => @vpc,
    "scheduledEc2TaskDefinitionOptions" => @scheduled_ec2_task_definition_options,
    "scheduledEc2TaskImageOptions" => @scheduled_ec2_task_image_options,
  })
  result.compact
end