batch

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeEnvironment 

type ComputeEnvironment struct {
	// contains filtered or unexported fields
}

Creates a AWS Batch compute environment. Compute environments contain the Amazon ECS container instances that are used to run containerized batch jobs.

For information about AWS Batch, see [What is AWS Batch?][1] . For information about compute environment, see [Compute Environments][2] .

> **Note:** To prevent a race condition during environment deletion, make sure to set `depends_on` to the related `aws_iam_role_policy_attachment`; 

otherwise, the policy may be destroyed too soon and the compute environment will then get stuck in the `DELETING` state, see [Troubleshooting AWS Batch][3] .

func GetComputeEnvironment 

func GetComputeEnvironment(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ComputeEnvironmentState, opts ...pulumi.ResourceOpt) (*ComputeEnvironment, error)

GetComputeEnvironment gets an existing ComputeEnvironment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewComputeEnvironment 

func NewComputeEnvironment(ctx *pulumi.Context,
	name string, args *ComputeEnvironmentArgs, opts ...pulumi.ResourceOpt) (*ComputeEnvironment, error)

NewComputeEnvironment registers a new resource with the given unique name, arguments, and options.

func (*ComputeEnvironment) Arn 

func (r *ComputeEnvironment) Arn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the compute environment.

func (*ComputeEnvironment) ComputeEnvironmentName 

func (r *ComputeEnvironment) ComputeEnvironmentName() *pulumi.StringOutput

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

func (*ComputeEnvironment) ComputeResources 

func (r *ComputeEnvironment) ComputeResources() *pulumi.Output

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. See details below.

func (*ComputeEnvironment) EcsClusterArn 

func (r *ComputeEnvironment) EcsClusterArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

func (*ComputeEnvironment) ID 

func (r *ComputeEnvironment) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ComputeEnvironment) ServiceRole 

func (r *ComputeEnvironment) ServiceRole() *pulumi.StringOutput

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

func (*ComputeEnvironment) State 

func (r *ComputeEnvironment) State() *pulumi.StringOutput

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. Valid items are `ENABLED` or `DISABLED`. Defaults to `ENABLED`.

func (*ComputeEnvironment) Status 

func (r *ComputeEnvironment) Status() *pulumi.StringOutput

The current status of the compute environment (for example, CREATING or VALID).

func (*ComputeEnvironment) StatusReason 

func (r *ComputeEnvironment) StatusReason() *pulumi.StringOutput

A short, human-readable string to provide additional details about the current status of the compute environment.

func (*ComputeEnvironment) Type 

func (r *ComputeEnvironment) Type() *pulumi.StringOutput

The type of compute environment. Valid items are `EC2` or `SPOT`.

func (*ComputeEnvironment) URN 

func (r *ComputeEnvironment) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ComputeEnvironmentArgs 

type ComputeEnvironmentArgs struct {
	// The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
	ComputeEnvironmentName interface{}
	// Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. See details below.
	ComputeResources interface{}
	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
	ServiceRole interface{}
	// 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. Valid items are `ENABLED` or `DISABLED`. Defaults to `ENABLED`.
	State interface{}
	// The type of compute environment. Valid items are `EC2` or `SPOT`.
	Type interface{}
}

The set of arguments for constructing a ComputeEnvironment resource.

type ComputeEnvironmentState 

type ComputeEnvironmentState struct {
	// The Amazon Resource Name (ARN) of the compute environment.
	Arn interface{}
	// The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
	ComputeEnvironmentName interface{}
	// Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. See details below.
	ComputeResources interface{}
	// The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
	EcsClusterArn interface{}
	// The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
	ServiceRole interface{}
	// 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. Valid items are `ENABLED` or `DISABLED`. Defaults to `ENABLED`.
	State interface{}
	// The current status of the compute environment (for example, CREATING or VALID).
	Status interface{}
	// A short, human-readable string to provide additional details about the current status of the compute environment.
	StatusReason interface{}
	// The type of compute environment. Valid items are `EC2` or `SPOT`.
	Type interface{}
}

Input properties used for looking up and filtering ComputeEnvironment resources.

type GetComputeEnvironmentArgs 

type GetComputeEnvironmentArgs struct {
	// The name of the Batch Compute Environment
	ComputeEnvironmentName interface{}
}

A collection of arguments for invoking getComputeEnvironment.

type GetComputeEnvironmentResult 

type GetComputeEnvironmentResult struct {
	// The ARN of the compute environment.
	Arn interface{}
	// The ARN of the underlying Amazon ECS cluster used by the compute environment.
	EcsClusterArn interface{}
	// The ARN of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
	ServiceRole interface{}
	// The state of the compute environment (for example, `ENABLED` or `DISABLED`). If the state is `ENABLED`, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
	State interface{}
	// The current status of the compute environment (for example, `CREATING` or `VALID`).
	Status interface{}
	// A short, human-readable string to provide additional details about the current status of the compute environment.
	StatusReason interface{}
	// The type of the compute environment (for example, `MANAGED` or `UNMANAGED`).
	Type interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getComputeEnvironment.

func LookupComputeEnvironment 

func LookupComputeEnvironment(ctx *pulumi.Context, args *GetComputeEnvironmentArgs) (*GetComputeEnvironmentResult, error)

The Batch Compute Environment data source allows access to details of a specific compute environment within AWS Batch.

type GetJobQueueArgs 

type GetJobQueueArgs struct {
	// The name of the job queue.
	Name interface{}
}

A collection of arguments for invoking getJobQueue.

type GetJobQueueResult 

type GetJobQueueResult struct {
	// The ARN of the job queue.
	Arn interface{}
	// The compute environments that are attached to the job queue and the order in
	// which job placement is preferred. Compute environments are selected for job placement in ascending order.
	// * `compute_environment_order.#.order` - The order of the compute environment.
	// * `compute_environment_order.#.compute_environment` - The ARN of the compute environment.
	ComputeEnvironmentOrders interface{}
	// The priority of the job queue. Job queues with a higher priority are evaluated first when
	// associated with the same compute environment.
	Priority interface{}
	// Describes the ability of the queue to accept new jobs (for example, `ENABLED` or `DISABLED`).
	State interface{}
	// The current status of the job queue (for example, `CREATING` or `VALID`).
	Status interface{}
	// A short, human-readable string to provide additional details about the current status
	// of the job queue.
	StatusReason interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getJobQueue.

func LookupJobQueue 

func LookupJobQueue(ctx *pulumi.Context, args *GetJobQueueArgs) (*GetJobQueueResult, error)

The Batch Job Queue data source allows access to details of a specific job queue within AWS Batch.

type JobDefinition 

type JobDefinition struct {
	// contains filtered or unexported fields
}

Provides a Batch Job Definition resource.

## retry_strategy

`retry_strategy` supports the following:

* `attempts` - (Optional) The number of times to move a job to the `RUNNABLE` status. You may specify between `1` and `10` attempts.

## timeout

`timeout` supports the following:

* `attempt_duration_seconds` - (Optional) The time duration in seconds after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is `60` seconds.

func GetJobDefinition 

func GetJobDefinition(ctx *pulumi.Context,
	name string, id pulumi.ID, state *JobDefinitionState, opts ...pulumi.ResourceOpt) (*JobDefinition, error)

GetJobDefinition gets an existing JobDefinition resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewJobDefinition 

func NewJobDefinition(ctx *pulumi.Context,
	name string, args *JobDefinitionArgs, opts ...pulumi.ResourceOpt) (*JobDefinition, error)

NewJobDefinition registers a new resource with the given unique name, arguments, and options.

func (*JobDefinition) Arn 

func (r *JobDefinition) Arn() *pulumi.StringOutput

The Amazon Resource Name of the job definition.

func (*JobDefinition) ContainerProperties 

func (r *JobDefinition) ContainerProperties() *pulumi.StringOutput

A valid [container properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html) provided as a single valid JSON document. This parameter is required if the `type` parameter is `container`.

func (*JobDefinition) ID 

func (r *JobDefinition) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*JobDefinition) Name 

func (r *JobDefinition) Name() *pulumi.StringOutput

Specifies the name of the job definition.

func (*JobDefinition) Parameters 

func (r *JobDefinition) Parameters() *pulumi.MapOutput

Specifies the parameter substitution placeholders to set in the job definition.

func (*JobDefinition) RetryStrategy 

func (r *JobDefinition) RetryStrategy() *pulumi.Output

Specifies the retry strategy to use for failed jobs that are submitted with this job definition. Maximum number of `retry_strategy` is `1`. Defined below.

func (*JobDefinition) Revision 

func (r *JobDefinition) Revision() *pulumi.IntOutput

The revision of the job definition.

func (*JobDefinition) Timeout 

func (r *JobDefinition) Timeout() *pulumi.Output

Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of `timeout` is `1`. Defined below.

func (*JobDefinition) Type 

func (r *JobDefinition) Type() *pulumi.StringOutput

The type of job definition. Must be `container`

func (*JobDefinition) URN 

func (r *JobDefinition) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type JobDefinitionArgs 

type JobDefinitionArgs struct {
	// A valid [container properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html)
	// provided as a single valid JSON document. This parameter is required if the `type` parameter is `container`.
	ContainerProperties interface{}
	// Specifies the name of the job definition.
	Name interface{}
	// Specifies the parameter substitution placeholders to set in the job definition.
	Parameters interface{}
	// Specifies the retry strategy to use for failed jobs that are submitted with this job definition.
	// Maximum number of `retry_strategy` is `1`.  Defined below.
	RetryStrategy interface{}
	// Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of `timeout` is `1`. Defined below.
	Timeout interface{}
	// The type of job definition.  Must be `container`
	Type interface{}
}

The set of arguments for constructing a JobDefinition resource.

type JobDefinitionState 

type JobDefinitionState struct {
	// The Amazon Resource Name of the job definition.
	Arn interface{}
	// A valid [container properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html)
	// provided as a single valid JSON document. This parameter is required if the `type` parameter is `container`.
	ContainerProperties interface{}
	// Specifies the name of the job definition.
	Name interface{}
	// Specifies the parameter substitution placeholders to set in the job definition.
	Parameters interface{}
	// Specifies the retry strategy to use for failed jobs that are submitted with this job definition.
	// Maximum number of `retry_strategy` is `1`.  Defined below.
	RetryStrategy interface{}
	// The revision of the job definition.
	Revision interface{}
	// Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of `timeout` is `1`. Defined below.
	Timeout interface{}
	// The type of job definition.  Must be `container`
	Type interface{}
}

Input properties used for looking up and filtering JobDefinition resources.

type JobQueue 

type JobQueue struct {
	// contains filtered or unexported fields
}

Provides a Batch Job Queue resource.

func GetJobQueue 

func GetJobQueue(ctx *pulumi.Context,
	name string, id pulumi.ID, state *JobQueueState, opts ...pulumi.ResourceOpt) (*JobQueue, error)

GetJobQueue gets an existing JobQueue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewJobQueue 

func NewJobQueue(ctx *pulumi.Context,
	name string, args *JobQueueArgs, opts ...pulumi.ResourceOpt) (*JobQueue, error)

NewJobQueue registers a new resource with the given unique name, arguments, and options.

func (*JobQueue) Arn 

func (r *JobQueue) Arn() *pulumi.StringOutput

The Amazon Resource Name of the job queue.

func (*JobQueue) ComputeEnvironments 

func (r *JobQueue) ComputeEnvironments() *pulumi.ArrayOutput

Specifies the set of compute environments mapped to a job queue and their order. The position of the compute environments in the list will dictate the order. You can associate up to 3 compute environments with a job queue.

func (*JobQueue) ID 

func (r *JobQueue) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*JobQueue) Name 

func (r *JobQueue) Name() *pulumi.StringOutput

Specifies the name of the job queue.

func (*JobQueue) Priority 

func (r *JobQueue) Priority() *pulumi.IntOutput

The priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

func (*JobQueue) State 

func (r *JobQueue) State() *pulumi.StringOutput

The state of the job queue. Must be one of: `ENABLED` or `DISABLED`

func (*JobQueue) URN 

func (r *JobQueue) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type JobQueueArgs 

type JobQueueArgs struct {
	// Specifies the set of compute environments
	// mapped to a job queue and their order.  The position of the compute environments
	// in the list will dictate the order. You can associate up to 3 compute environments
	// with a job queue.
	ComputeEnvironments interface{}
	// Specifies the name of the job queue.
	Name interface{}
	// The priority of the job queue. Job queues with a higher priority
	// are evaluated first when associated with the same compute environment.
	Priority interface{}
	// The state of the job queue. Must be one of: `ENABLED` or `DISABLED`
	State interface{}
}

The set of arguments for constructing a JobQueue resource.

type JobQueueState 

type JobQueueState struct {
	// The Amazon Resource Name of the job queue.
	Arn interface{}
	// Specifies the set of compute environments
	// mapped to a job queue and their order.  The position of the compute environments
	// in the list will dictate the order. You can associate up to 3 compute environments
	// with a job queue.
	ComputeEnvironments interface{}
	// Specifies the name of the job queue.
	Name interface{}
	// The priority of the job queue. Job queues with a higher priority
	// are evaluated first when associated with the same compute environment.
	Priority interface{}
	// The state of the job queue. Must be one of: `ENABLED` or `DISABLED`
	State interface{}
}

Input properties used for looking up and filtering JobQueue resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.