Infrastructure as Code Jobs
The following topics describe job attributes that work with cloud computing platforms and services:
AWS CloudFormation Job
AWS CloudFormation enables you to create, configure, test, and manage your AWS infrastructure, which is a collection of AWS services and resources.
The following table describes the AWS CloudFormation job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to AWS CloudFormation. Rules:
|
Action |
Determines one of the following CloudFormation actions to perform:
|
Stack Name |
Defines a unique stack name. A stack is a collection of AWS resources, such as a web server or database. |
Stack Parameters |
Determines one of the following templates to create or update:
A template defines the properties of your AWS infrastructure. |
Template URL |
Defines the URL for a preexisting template. Rules:
|
Template Body |
Defines the template in JSON or YAML format. YAML: Copy
|
Role ARN |
Defines the Amazon Resource Name (ARN) of the AWS IAM Role that CloudFormation runs as to create or update a stack. An ARN is a standardized AWS resource address. The AWS IAM role must be granted read and write privileges to create or update any of the AWS resources that are in the stack. arn:aws:iam::12345678910:role/AWS-QuickSetup-StackSet-Local-AdministrationRole |
Capabilities Type |
Defines the capabilities of your template and stack.
Default: Capability IAM |
Enable Termination Protection |
Determines whether to prevent deletion of this stack by other users. |
On Failure |
Determines one of the following actions to take when the job ends Not OK:
Default: Do Nothing |
Status Polling Frequency |
Determines the number of seconds to wait before Control-M checks the status of the job. Default: 15 |
Failure Tolerance |
Determines the number of times to check the job status before the job ends Not OK. Default: 2 |
Azure Resource Manager Job
Azure Resource Manager enables you to create, configure, test, and manage your Azure resources infrastructure.
The following table describes the Azure Resource Manager job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to Azure Resource Manager. Rules:
|
Resource Group Name |
Defines a unique resource group name. A resource group is a collection of Azure resources, such as a virtual machine or database, that share the same permissions. |
Action |
Determines one of the following actions to perform:
|
Deployment Name |
Defines the deployment name. |
Deployment Properties |
Defines an API request, in JSON format, that enables you to add or update resources in a resource group. Update Deployment: Copy
|
Failure Tolerance |
Determines the number of times to check the job status before the job ends Not OK. Default: 2 |
Status Polling Frequency |
Determines the number of seconds to wait before Control-M checks the status of the job. Default: 15 |
GCP Deployment Manager Job
GCP Deployment Manager enables you to create, configure, test, and manage your GCP resources infrastructure.
The following table describes the GCP Deployment Manager job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to GCP Deployment Manager. Rules:
|
Project ID |
Defines a unique GCP project ID for this job. |
Action |
Determines one of the following actions to perform:
A deployment is a collection of API resources, such as a Google Compute Engine or GCP Cloud SQL instance. |
Deployment Name |
Defines a unique deployment name. |
YAML Config Content |
Defines a configuration, in YAML format, which enables you to add or update resources in a deployment. You must use the YAML Minifier Tool to remove all unnecessary characters from your configuration code. Copy
|
Status Polling Frequency |
Determines the number of seconds to wait before Control-M checks the status of the job. Default: 10 |
Tolerance |
Determines the number of times to check the job status before the job ends Not OK. Default: 3 |
Terraform Job
Terraform is an open-source Infrastructure as Code (IaC) tool that enables you to create, configure, test, and manage your infrastructure on multiple platforms in a declarative way, using configuration files that describe the desired state of your infrastructure.
The following table describes the Terraform job attributes:
Attribute |
Action |
Description |
---|---|---|
Connection Profile |
N/A |
Defines the name of a Connection Profile to use to connect Control-M to Terraform. Rules: Case Sensitive |
Action |
N/A |
Determines one of the following Terraform actions to perform:
|
Workspace Params |
Create Workspace |
Defines the details of the workspace to create, in JSON format. Copy
Characters: maximum of 4,000 |
Workspace Name |
|
Defines a name for the workspace where you want to perform the action. |
Run Name |
Run Workspace |
Defines the name of the workspace run in Terraform. |
Variables |
Run Workspace |
Defines the variables for this workspace run, in JSON format. Copy
For no parameters, type {}. |
Variable |
Create Variable |
Defines the details of the variable in the Terraform workspace, in JSON format. Copy
|
Status Polling Frequency |
All Actions |
(Optional) Determines the number of seconds to wait before checking the status of the job between intervals. Default: 20 |
Failure Tolerance |
All Actions |
Determines the number of times to check the job status before ending Not OK. Default: 2 |