Class: Ansible::Ruby::Modules::Aws_batch_compute_environment

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb

Overview

This module allows the management of AWS Batch Compute Environments. It is idempotent and supports “Check” mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#bid_percentage ⇒ Object?

Returns The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

Returns:

  • (Object, nil) —

    The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 72

attribute :bid_percentage

#compute_environment_name ⇒ Object

Returns The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

Returns:

  • (Object) —

    The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 12

attribute :compute_environment_name

#compute_environment_state ⇒ :ENABLED, ...

Returns The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

Returns:

  • (:ENABLED, :DISABLED, nil) —

    The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 24

attribute :compute_environment_state

#compute_resource_type ⇒ :EC2, :SPOT

Returns The type of compute resource.

Returns:

  • (:EC2, :SPOT) —

    The type of compute resource.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 32

attribute :compute_resource_type

#desiredv_cpus ⇒ Object?

Returns The desired number of EC2 vCPUS in the compute environment.

Returns:

  • (Object, nil) —

    The desired number of EC2 vCPUS in the compute environment.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 44

attribute :desiredv_cpus

#ec2_key_pair ⇒ Object?

Returns The EC2 key pair that is used for instances launched in the compute environment.

Returns:

  • (Object, nil) —

    The EC2 key pair that is used for instances launched in the compute environment.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 62

attribute :ec2_key_pair

#image_id ⇒ Object?

Returns The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

Returns:

  • (Object, nil) —

    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 51

attribute :image_id

#instance_role ⇒ Object

Returns The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.

Returns:

  • (Object) —

    The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 65

attribute :instance_role

#instance_types ⇒ Object

Returns The instance types that may be launched.

Returns:

  • (Object) —

    The instance types that may be launched.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 47

attribute :instance_types

#maxv_cpus ⇒ Object

Returns The maximum number of EC2 vCPUs that an environment can reach.

Returns:

  • (Object) —

    The maximum number of EC2 vCPUs that an environment can reach.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 40

attribute :maxv_cpus

#minv_cpus ⇒ Object

Returns The minimum number of EC2 vCPUs that an environment should maintain.

Returns:

  • (Object) —

    The minimum number of EC2 vCPUs that an environment should maintain.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 36

attribute :minv_cpus

#security_group_ids ⇒ Object

Returns The EC2 security groups that are associated with instances launched in the compute environment.

Returns:

  • (Object) —

    The EC2 security groups that are associated with instances launched in the compute environment.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 58

attribute :security_group_ids

#service_role ⇒ Object

Returns The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

Returns:

  • (Object) —

    The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 28

attribute :service_role

#spot_iam_fleet_role ⇒ Object?

Returns The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

Returns:

  • (Object, nil) —

    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 75

attribute :spot_iam_fleet_role

#state ⇒ :present, :absent

Returns Describes the desired state.

Returns:

  • (:present, :absent) —

    Describes the desired state.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 20

attribute :state

#subnets ⇒ Object

Returns The VPC subnets into which the compute resources are launched.

Returns:

  • (Object) —

    The VPC subnets into which the compute resources are launched.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 54

attribute :subnets

#tags ⇒ Object?

Returns Key-value pair tags to be applied to resources that are launched in the compute environment.

Returns:

  • (Object, nil) —

    Key-value pair tags to be applied to resources that are launched in the compute environment.



69
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 69

attribute :tags

#type ⇒ :MANAGED, :UNMANAGED

Returns The type of the compute environment.

Returns:

  • (:MANAGED, :UNMANAGED) —

    The type of the compute environment.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_compute_environment.rb', line 16

attribute :type