Class: MintPress::Aws::ECS::Service

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb

Properties (Read/Write)

  • #capacity_provider_strategy ⇒ Array of ⇒ [MintPress::Aws::ECS::CapacityProviderStrategyItem]
    'The capacity provider strategy to update the service to use. If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster"s default capacity provider strategy. A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'capacity_provider_strategy'
    • create_service_prop ⇒ 'capacity_provider_strategy'
    • read_only ⇒ false
    • update_service_prop ⇒ 'capacity_provider_strategy'
    

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 36

property :capacity_provider_strategy, description: 'The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the
cluster, the service can be updated to use one or more capacity
providers as opposed to the default capacity provider strategy.
However, when a service is using a capacity provider strategy that is
not the default capacity provider strategy, the service cannot be
updated to use the cluster"s default capacity provider strategy.

A capacity provider strategy consists of one or more capacity
providers along with the base and weight to assign to them. A
capacity provider must be associated with the cluster to be used in a
capacity provider strategy. The PutClusterCapacityProviders API is
used to associate a capacity provider with a cluster. Only capacity
providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the
capacity provider must already be created. New capacity providers can
be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT capacity providers. The AWS Fargate capacity
providers are available to all accounts and only need to be associated
with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the
list of available capacity providers for a cluster after the cluster
is created.', source: "update_service", orig_name: 'capacity_provider_strategy', type: [MintPress::Aws::ECS::CapacityProviderStrategyItem], array: true, create_service_prop: 'capacity_provider_strategy', read_only: false, update_service_prop: 'capacity_provider_strategy'
  • #cluster_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the cluster that hosts the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'cluster_arn'
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 64

property :cluster_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the cluster that hosts the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'cluster_arn', type: [String]
  • #created_at ⇒ [Time]
    'The Unix timestamp for when the service was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'created_at'
    

65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 65

property :created_at, disposition: :attribute, description: 'The Unix timestamp for when the service was created.', source: "MintPress::Aws::ECS::Service", orig_name: 'created_at', type: [Time]
  • #created_by ⇒ [String]
    'The principal that created the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'created_by'
    

66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 66

property :created_by, disposition: :attribute, description: 'The principal that created the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'created_by', type: [String]
  • #deployment_configuration ⇒ [MintPress::Aws::ECS::DeploymentConfiguration] (Default Value: MintPress::Aws::ECS::DeploymentConfiguration.new)
    'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'deployment_configuration'
    • default ⇒ MintPress::Aws::ECS::DeploymentConfiguration.new
    • create_service_prop ⇒ 'deployment_configuration'
    • read_only ⇒ false
    • update_service_prop ⇒ 'deployment_configuration'
    

67
68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 67

property :deployment_configuration, description: 'Optional deployment parameters that control how many tasks run during
the deployment and the ordering of stopping and starting tasks.', source: "update_service", orig_name: 'deployment_configuration', type: [MintPress::Aws::ECS::DeploymentConfiguration], default: MintPress::Aws::ECS::DeploymentConfiguration.new, create_service_prop: 'deployment_configuration', read_only: false, update_service_prop: 'deployment_configuration'
  • #deployment_controller ⇒ [String]
    'The deployment controller type the service is using.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'deployment_controller'
    • create_service_prop ⇒ "deployment_controller.type"
    • read_only ⇒ false
    

69
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 69

property :deployment_controller, disposition: :attribute, description: 'The deployment controller type the service is using.', source: "MintPress::Aws::ECS::Service", orig_name: 'deployment_controller', type: [String], create_service_prop: "deployment_controller.type", read_only: false
  • #deployments ⇒ Hash of ⇒ [MintPress::Aws::ECS::Deployment]
    'The current state of deployments for the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'deployments'
    

70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 70

property :deployments, disposition: :attribute, description: 'The current state of deployments for the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'deployments', type: [MintPress::Aws::ECS::Deployment], array: false, hash: true
  • #desired_count ⇒ [Integer]
    'The number of instantiations of the task to place and keep running in your service.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'desired_count'
    • create_service_prop ⇒ 'desired_count'
    • read_only ⇒ false
    • update_service_prop ⇒ 'desired_count'
    

71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 71

property :desired_count, description: 'The number of instantiations of the task to place and keep running in
your service.', source: "update_service", orig_name: 'desired_count', type: [Integer], create_service_prop: 'desired_count', read_only: false, update_service_prop: 'desired_count'
  • #enable_ecs_managed_tags ⇒ [TrueClass,FalseClass]
    'Specifies whether to enable Amazon ECS managed tags for the tasks in the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'enable_ecs_managed_tags'
    • create_service_prop ⇒ 'enable_ecs_managed_tags'
    • read_only ⇒ false
    

73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 73

property :enable_ecs_managed_tags, disposition: :attribute, description: 'Specifies whether to enable Amazon ECS managed tags for the tasks in the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'enable_ecs_managed_tags', type: [TrueClass,FalseClass], create_service_prop: 'enable_ecs_managed_tags', read_only: false
  • #events ⇒ Hash of ⇒ [MintPress::Aws::ECS::ServiceEvent]
    'The event stream for your service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'events'
    

74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 74

property :events, disposition: :attribute, description: 'The event stream for your service.', source: "MintPress::Aws::ECS::Service", orig_name: 'events', type: [MintPress::Aws::ECS::ServiceEvent], array: false, hash: true
  • #health_check_grace_period_seconds ⇒ [Integer]
    'The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service"s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'health_check_grace_period_seconds'
    • create_service_prop ⇒ 'health_check_grace_period_seconds'
    • read_only ⇒ false
    • update_service_prop ⇒ 'health_check_grace_period_seconds'
    

75
76
77
78
79
80
81
82
83
84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 75

property :health_check_grace_period_seconds, description: 'The period of time, in seconds, that the Amazon ECS service scheduler
should ignore unhealthy Elastic Load Balancing target health checks
after a task has first started. This is only valid if your service is
configured to use a load balancer. If your service"s tasks take a
while to start and respond to Elastic Load Balancing health checks,
you can specify a health check grace period of up to 2,147,483,647
seconds. During that time, the Amazon ECS service scheduler ignores
the Elastic Load Balancing health check status. This grace period can
prevent the ECS service scheduler from marking tasks as unhealthy and
stopping them before they have time to come up.', source: "update_service", orig_name: 'health_check_grace_period_seconds', type: [Integer], create_service_prop: 'health_check_grace_period_seconds', read_only: false, update_service_prop: 'health_check_grace_period_seconds'
  • #launch_type ⇒ [String]
    'The launch type for the services to list.'
    Property Attributes
    • source ⇒ "list_services"
    • orig_name ⇒ 'launch_type'
    • create_service_prop ⇒ 'launch_type'
    • read_only ⇒ false
    • list_services_prop ⇒ 'launch_type'
    

85
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 85

property :launch_type, description: 'The launch type for the services to list.', source: "list_services", orig_name: 'launch_type', type: [String], create_service_prop: 'launch_type', read_only: false, list_services_prop: 'launch_type'
  • #load_balancers ⇒ Array of ⇒ [MintPress::Aws::ECS::LoadBalancer]
    'A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'load_balancers'
    • create_service_prop ⇒ 'load_balancers'
    • read_only ⇒ false
    

86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 86

property :load_balancers, disposition: :attribute, description: 'A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.', source: "MintPress::Aws::ECS::Service", orig_name: 'load_balancers', type: [MintPress::Aws::ECS::LoadBalancer], array: true, create_service_prop: 'load_balancers', read_only: false
  • #network_configuration ⇒ [MintPress::Aws::ECS::AwsVpcConfiguration]
    'An object representing the network configuration for a task or service.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'network_configuration'
    • create_service_prop ⇒ "network_configuration.awsvpc_configuration"
    • read_only ⇒ false
    • update_service_prop ⇒ "network_configuration.awsvpc_configuration"
    

87
88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 87

property :network_configuration, description: 'An object representing the network configuration for a task or
service.', source: "update_service", orig_name: 'network_configuration', type: [MintPress::Aws::ECS::AwsVpcConfiguration], create_service_prop: "network_configuration.awsvpc_configuration", read_only: false, update_service_prop: "network_configuration.awsvpc_configuration"
  • #pending_count ⇒ [Integer]
    'The number of tasks in the cluster that are in the PENDING state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'pending_count'
    

89
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 89

property :pending_count, disposition: :attribute, description: 'The number of tasks in the cluster that are in the PENDING state.', source: "MintPress::Aws::ECS::Service", orig_name: 'pending_count', type: [Integer]
  • #placement_constraints ⇒ Array of ⇒ [MintPress::Aws::ECS::PlacementConstraint]
    'An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'placement_constraints'
    • create_service_prop ⇒ 'placement_constraints'
    • read_only ⇒ false
    • update_service_prop ⇒ 'placement_constraints'
    

90
91
92
93
94
95
96
97
98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 90

property :placement_constraints, description: 'An array of task placement constraint objects to update the service to
use. If no value is specified, the existing placement constraints for
the service will remain unchanged. If this value is specified, it will
override any existing placement constraints defined for the service.
To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit
includes constraints in the task definition and those specified at
runtime).', source: "update_service", orig_name: 'placement_constraints', type: [MintPress::Aws::ECS::PlacementConstraint], array: true, create_service_prop: 'placement_constraints', read_only: false, update_service_prop: 'placement_constraints'
  • #placement_strategy ⇒ Array of ⇒ [MintPress::Aws::ECS::PlacementStrategy]
    'The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object. You can specify a maximum of five strategy rules per service.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'placement_strategy'
    • create_service_prop ⇒ 'placement_strategy'
    • read_only ⇒ false
    • update_service_prop ⇒ 'placement_strategy'
    

99
100
101
102
103
104
105
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 99

property :placement_strategy, description: 'The task placement strategy objects to update the service to use. If
no value is specified, the existing placement strategy for the service
will remain unchanged. If this value is specified, it will override
the existing placement strategy defined for the service. To remove an
existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.', source: "update_service", orig_name: 'placement_strategy', type: [MintPress::Aws::ECS::PlacementStrategy], array: true, create_service_prop: 'placement_strategy', read_only: false, update_service_prop: 'placement_strategy'
  • #platform_version ⇒ [String]
    'The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'platform_version'
    • create_service_prop ⇒ 'platform_version'
    • read_only ⇒ false
    • update_service_prop ⇒ 'platform_version'
    

106
107
108
109
110
111
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 106

property :platform_version, description: 'The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If a platform version is not specified, the LATEST platform
version is used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service
Developer Guide.', source: "update_service", orig_name: 'platform_version', type: [String], create_service_prop: 'platform_version', read_only: false, update_service_prop: 'platform_version'
  • #propagate_tags ⇒ [String]
    'Specifies whether to propagate the tags from the task definition or the service to the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'propagate_tags'
    • create_service_prop ⇒ 'propagate_tags'
    • read_only ⇒ false
    

112
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 112

property :propagate_tags, disposition: :attribute, description: 'Specifies whether to propagate the tags from the task definition or the service to the task.', source: "MintPress::Aws::ECS::Service", orig_name: 'propagate_tags', type: [String], create_service_prop: 'propagate_tags', read_only: false
  • #role_arn ⇒ [String]
    'The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'role_arn'
    

113
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 113

property :role_arn, disposition: :attribute, description: 'The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.', source: "MintPress::Aws::ECS::Service", orig_name: 'role_arn', type: [String]
  • #running_count ⇒ [Integer]
    'The number of tasks in the cluster that are in the RUNNING state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'running_count'
    

114
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 114

property :running_count, disposition: :attribute, description: 'The number of tasks in the cluster that are in the RUNNING state.', source: "MintPress::Aws::ECS::Service", orig_name: 'running_count', type: [Integer]
  • #scheduling_strategy ⇒ [String]
    'The scheduling strategy for services to list.'
    Property Attributes
    • source ⇒ "list_services"
    • orig_name ⇒ 'scheduling_strategy'
    • create_service_prop ⇒ 'scheduling_strategy'
    • read_only ⇒ false
    • list_services_prop ⇒ 'scheduling_strategy'
    

115
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 115

property :scheduling_strategy, description: 'The scheduling strategy for services to list.', source: "list_services", orig_name: 'scheduling_strategy', type: [String], create_service_prop: 'scheduling_strategy', read_only: false, list_services_prop: 'scheduling_strategy'
  • #service_arn ⇒ [String]
    'The ARN that identifies the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'service_arn'
    

116
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 116

property :service_arn, disposition: :attribute, description: 'The ARN that identifies the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'service_arn', type: [String]
  • #service_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of your service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'service_name'
    • create_service_prop ⇒ 'service_name'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

117
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 117

property :service_name, disposition: :attribute, description: 'The name of your service.', source: "MintPress::Aws::ECS::Service", orig_name: 'service_name', type: [String], create_service_prop: 'service_name', read_only: false, default: Proc.new { self.name }
  • #service_registries ⇒ Hash of ⇒ [MintPress::Aws::ECS::ServiceRegistry]
    'The details of the service discovery registries to assign to this service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'service_registries'
    • create_service_prop ⇒ 'service_registries'
    • read_only ⇒ false
    

118
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 118

property :service_registries, disposition: :attribute, description: 'The details of the service discovery registries to assign to this service.', source: "MintPress::Aws::ECS::Service", orig_name: 'service_registries', type: [MintPress::Aws::ECS::ServiceRegistry], array: false, create_service_prop: 'service_registries', read_only: false, hash: true
  • #status ⇒ [String]
    'The status of the service.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'status'
    

119
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 119

property :status, disposition: :attribute, description: 'The status of the service.', source: "MintPress::Aws::ECS::Service", orig_name: 'status', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::ECS::Tag]
    'The metadata that you apply to the service to help you categorize and organize them.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'tags'
    • create_service_prop ⇒ 'tags'
    • read_only ⇒ false
    

120
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 120

property :tags, disposition: :attribute, description: 'The metadata that you apply to the service to help you categorize and organize them.', source: "MintPress::Aws::ECS::Service", orig_name: 'tags', type: [MintPress::Aws::ECS::Tag], array: false, create_service_prop: 'tags', read_only: false, hash: true
  • #task_definition ⇒ [String]
    'The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.'
    Property Attributes
    • source ⇒ "update_service"
    • orig_name ⇒ 'task_definition'
    • create_service_prop ⇒ 'task_definition'
    • read_only ⇒ false
    • update_service_prop ⇒ 'task_definition'
    

121
122
123
124
125
126
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 121

property :task_definition, description: 'The family and revision (family:revision) or full ARN of the
task definition to run in your service. If a revision is not
specified, the latest ACTIVE revision is used. If you modify the
task definition with UpdateService, Amazon ECS spawns a task with
the new version of the task definition and then stops an old task
after the new version is running.', source: "update_service", orig_name: 'task_definition', type: [String], create_service_prop: 'task_definition', read_only: false, update_service_prop: 'task_definition'
  • #task_sets ⇒ Hash of ⇒ [MintPress::Aws::ECS::TaskSet]
    'Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Service"
    • orig_name ⇒ 'task_sets'
    

127
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 127

property :task_sets, disposition: :attribute, description: 'Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment.', source: "MintPress::Aws::ECS::Service", orig_name: 'task_sets', type: [MintPress::Aws::ECS::TaskSet], array: false, hash: true
  • #cluster ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.'
    Property Attributes
    • create_service_prop ⇒ 'cluster'
    • read_only ⇒ false
    • source ⇒ "update_service"
    • delete_service_prop ⇒ 'cluster'
    • describe_services_prop ⇒ 'cluster'
    • list_services_prop ⇒ 'cluster'
    • update_service_prop ⇒ 'cluster'
    

128
129
130
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 128

property :cluster, create_service_prop: 'cluster', type: [String], read_only: false, source: "update_service", description: 'The short name or full Amazon Resource Name (ARN) of the cluster that
your service is running on. If you do not specify a cluster, the
default cluster is assumed.', delete_service_prop: 'cluster', describe_services_prop: 'cluster', list_services_prop: 'cluster', update_service_prop: 'cluster'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.'
    Property Attributes
    • create_service_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_service"
    

131
132
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 131

property :client_token, create_service_prop: 'client_token', type: [String], read_only: false, source: "create_service", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. Up to 32 ASCII characters are allowed.'
  • #role ⇒ [String]
    'The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.'
    Property Attributes
    • create_service_prop ⇒ 'role'
    • read_only ⇒ false
    • source ⇒ "create_service"
    

133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 133

property :role, create_service_prop: 'role', type: [String], read_only: false, source: "create_service", description: 'The name or full Amazon Resource Name (ARN) of the IAM role that
allows Amazon ECS to make calls to your load balancer on your behalf.
This parameter is only permitted if you are using a load balancer with
your service and your task definition does not use the awsvpc
network mode. If you specify the role parameter, you must also
specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked
role, that role is used by default for your service unless you specify
a role here. The service-linked role is required if your task
definition uses the awsvpc network mode or if the service is
configured to use service discovery, an external deployment
controller, multiple target groups, or Elastic Inference accelerators
in which case you should not specify a role here. For more
information, see Using Service-Linked Roles for Amazon ECS in the
Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either
specify the full role ARN (this is recommended) or prefix the role
name with the path. For example, if a role with the name bar has a
path of /foo/ then you would specify /foo/bar as the role name.
For more information, see Friendly Names and Paths in the IAM
User Guide.'
  • #service ⇒ [String]
    'The name of the service to update.'
    Property Attributes
    • delete_service_prop ⇒ 'service'
    • read_only ⇒ false
    • source ⇒ "update_service"
    • update_service_prop ⇒ 'service'
    

156
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 156

property :service, delete_service_prop: 'service', type: [String], read_only: false, source: "update_service", description: 'The name of the service to update.', update_service_prop: 'service'
  • #force ⇒ [TrueClass,FalseClass]
    'If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.'
    Property Attributes
    • delete_service_prop ⇒ 'force'
    • read_only ⇒ false
    • source ⇒ "delete_service"
    

157
158
159
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 157

property :force, delete_service_prop: 'force', type: [TrueClass,FalseClass], read_only: false, source: "delete_service", description: 'If true, allows you to delete a service even if it has not been
scaled down to zero tasks. It is only necessary to use this if the
service is using the REPLICA scheduling strategy.'
  • #services ⇒ Array of ⇒ [String]
    'A list of services to describe. You may specify up to 10 services to describe in a single operation.'
    Property Attributes
    • describe_services_prop ⇒ 'services'
    • source ⇒ "describe_services"
    

160
161
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 160

property :services, describe_services_prop: 'services', type: [String], array: true, source: "describe_services", description: 'A list of services to describe. You may specify up to 10 services to
describe in a single operation.'
  • #include ⇒ Array of ⇒ [String]
    'Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.'
    Property Attributes
    • describe_services_prop ⇒ 'include'
    • source ⇒ "describe_services"
    

162
163
164
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 162

property :include, describe_services_prop: 'include', type: [String], array: true, source: "describe_services", description: 'Specifies whether you want to see the resource tags for the service.
If TAGS is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.'
  • #max_results ⇒ [Integer]
    'The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.'
    Property Attributes
    • list_services_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_services"
    

165
166
167
168
169
170
171
172
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 165

property :max_results, list_services_prop: 'max_results', type: [Integer], read_only: false, source: "list_services", description: 'The maximum number of service results returned by ListServices in
paginated output. When this parameter is used, ListServices only
returns maxResults results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListServices request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListServices returns up to 10 results
and a nextToken value if applicable.'
  • #force_new_deployment ⇒ [TrueClass,FalseClass]
    'Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service"s tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.'
    Property Attributes
    • update_service_prop ⇒ 'force_new_deployment'
    • read_only ⇒ false
    • source ⇒ "update_service"
    

173
174
175
176
177
178
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 173

property :force_new_deployment, update_service_prop: 'force_new_deployment', type: [TrueClass,FalseClass], read_only: false, source: "update_service", description: 'Whether to force a new deployment of the service. Deployments are not
forced by default. You can use this option to trigger a new deployment
with no service definition changes. For example, you can update a
service"s tasks to use a newer Docker image with the same image/tag
combination (my_image:latest) or to roll Fargate tasks onto a newer
platform version.'
  • #name ⇒ [String]

    Property Attributes 
    

179
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 179

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

183
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 183

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

186
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/service.rb', line 186

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Service

Returns a new instance of Service.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object

#update ⇒ Object