Infrastructure as Code Jobs

Determines the authorization credentials that are used to connect Control-M to Ansible AWX, as described in CI/CD Connection Profiles.

Determines one of the following actions to perform:

• Launch Job Template: Runs a named Ansible AWX job template with configured playbook settings and the inventory you select in the Inventory parameter.

• Launch Job Template by ID: Runs an Ansible AWX job template defined by a numeric ID with configured playbook settings and the inventory you select in the Inventoryparameter.

• Launch Workflow Job Template: Runs a set sequence of job templates in an Ansible AWX automation workflow, with the inventory you select in the Inventoryparameter.

• Launch Workflow Job Template without Inventory: Runs a set sequence of job templates in an Ansible AWX automation workflow, with the default Ansible AWX inventory.

• Launch Workflow Job Template by ID: Runs a set sequence of job templates in an Ansible AWX automation workflow defined by a numeric ID, with the inventory you select in the Inventoryparameter.

• Launch Workflow Job Template by ID without Inventory: Runs a set sequence of job templates in an Ansible AWX automation workflow defined by a numeric ID, with the default Ansible AWX inventory.

• Sync Inventory Source: Updates hosts of an inventory based on information from cloud services or other resource providers.

• Sync Project: Refreshes playbooks and other files of a named project from the Ansible AWX source control repository.

• Sync Project by ID: Refreshes playbooks and other files of a project defined by a numeric ID from the Ansible AWX source control repository.

Determines the name of an Ansible AWX job template that defines how a particular playbook is executed.

If there are several templates with the same name, the job uses the first template found.

Determines the ID of an Ansible AWX job template that defines how a particular playbook is executed.

Determines the name of an Ansible AWX workflow template that defines a sequence of job templates and their relationships.

Determines the ID of an Ansible AWX workflow template that defines a sequence of job templates and their relationships.

Determines the name of an Ansible AWX project that contains Ansible playbooks and related files.

If there are several projects with the same name, the job uses the first project found.

Determines the ID of an Ansible AWX project that contains Ansible playbooks and related files.

Determines a group of hosts that are defined in Ansible AWX that is the target environment for job execution.

Determines a cloud provider or other source of hosts that Ansible AWX assigns to an inventory.

Defines job template launch parameters such as inventory, credentials, job variables, and limit options to define how the playbook runs and which host it targets.

Format: {"<param1>":<value1>,"<param2>":<value2>} (JSON format)

Example:

{
   "limit": "web_servers",
   "job_type": "run",
   "inventory": 5,
   "credentials": [10],
   "tags": "deploy",
   "skip_tags": "cleanup"
}

Determines whether the job returns a detailed execution record to Control-M.

Determines the number of seconds to wait before checking the job status.

Default: 15

Determines the authorization credentials that are used to connect Control-M to AWS CloudFormation, as described in AWS CloudFormation Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

Determines one of the following CloudFormation actions to perform:

• Create Stack: Creates a stack, which is a collection of AWS resources, such as a web server or database.

• Update Stack: Updates a stack.

• Delete Stack: Deletes a stack.

Defines a unique stack name.

A stack is a collection of AWS resources, such as a web server or database.

Determines one of the following templates to create or update:

• Template URL: Enables you to define the URL for a preexisting template.

• Template Body: Enables you to define the template in the job, in JSON or YAML format.

A template defines the properties of your AWS infrastructure.

Defines the URL for a preexisting template.

Rules:

• File Type: JSON- or YAML-formatted text files

• File Size: 450KB

• File Location:

  • JSON or YAML Files: Amazon S3 bucket

  • AWS Systems Manager: You must use the AWS Systems Manager to create a URL that points to the file location

Defines the template in JSON or YAML format.

AWSTemplateFormatVersion: 2010-09-09
Resources:
  OrdersTable:
    Type: AWS::DynamoDB::Table
    Properties:
      TableName: AuthorsTable_prod_Tt
      AttributeDefinitions:
        - AttributeName: "AuthorName"
          AttributeType: "S"
        - AttributeName: "BookTitle"
          AttributeType: "S"
      KeySchema:
        - AttributeName: "AuthorName"
          KeyType: "HASH"
        - AttributeName: "BookTitle"
          KeyType: "RANGE"
      TimeToLiveSpecification:
        AttributeName: "ExpirationTime"
        Enabled: true
      ProvisionedThroughput:
        ReadCapacityUnits: "10"
        WriteCapacityUnits: "5"
    DependsOn:
      - DynamoDBQueryPolicy
  DynamoDBQueryPolicy:
    Type: "AWS::IAM::Policy"
    Properties:
      PolicyName: DynamoDBQueryPolicy
      PolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: "Allow"
            Action: "dynamodb:Query"
            Resource: "*"
      Roles:
        - Ref: "OrdersTableQueryRole"
  OrdersTableQueryRole:
    Type: "AWS::IAM::Role"
    Properties:
      AssumeRolePolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: "Allow"
            Principal:
              Service:
                - "dynamodb.amazonaws.com"
            Action:
              - "sts:AssumeRole"
      Path: "/"

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.

Determines the capabilities of your template and stack.

Valid Values:

• Capability IAM

• Capability Named IAM

• Capability Auto-Expand

Default: Capability IAM

Determines whether to prevent deletion of this stack by other users.

Determines one of the following actions to take when the job ends Not OK.

Valid Values:

• Do Nothing: Leaves the created or updated stack as is.

• Roll Back: Reverts to the previous stack.

• Delete: Deletes the created or updated stack.

Default: Do Nothing

Determines the number of seconds to wait before checking the job status.

Default: 15

Determines the authorization credentials that are used to connect Control-M to Azure Resource Manager, as described in Azure Resource Manager Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

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.

Determines one of the following actions to perform:

• Create Deployment: Adds resources to a resource group.

• Update Deployment: Updates resources in a resource group.

Defines the deployment name.

Defines an API request, in JSON format, that enables you to add or update resources in a resource group.

{
  "properties": {
    "templateLink": {
      "uri": "https://test1.blob.core.windows.net/test123/Template_update.json?sp=r&st=2023-08-07T16:13:22Z&se
              =2023-12-03T01:13:22Z&sv=2022-11-02&sr=b&sig=mfFPtXBwmiW4MNH58ZTTJA%2FsAi1gjgKGuwxTlkTquGM%3D",
      "queryString": "sp=r&st=2023-08-07T16:13:22Z&se=2023-12-03T01:13:22Z&sv=2022-11-02&sr=b&sig=
                      mfFPtXBwmiW4MNH58ZTTJA%2FsAi1gjgKGuwxTlkTquGM%3D"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Determines the number of times to check the job status before the job ends Not OK.

Default: 2

Determines the authorization credentials that are used to connect Control-M to GCP Deployment Manager, as described in GCP Deployment Manager Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

Defines the identifier of the GCP project where the job runs.

A project is a set of configuration settings that define the resources the jobs utilize and how they interact with GCP.

Determines one of the following actions to perform:

• Create Deployment: Creates a deployment.

• Update Deployment: Updates a deployment.

• Delete Deployment: Deletes a deployment.

A deployment is a collection of API resources, such as a Google Compute Engine or GCP Cloud SQL instance.

Defines a unique deployment name.

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.

resources:
- type: compute.v1.instance
  name: quickstart-deployment-vm
  properties:
    zone: us-central1-f
    machineType: https://www.googleapis.com/compute/v1/projects/applied-lattice-333108/zones/us-central1-f/
                 machineTypes/f1-micro
    disks:
    - deviceName: boot
      type: PERSISTENT
      boot: true
      autoDelete: true
      initializeParams:
        sourceImage: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/family/debian-11
    networkInterfaces:
    - network: https://www.googleapis.com/compute/v1/projects/applied-lattice-333108/global/networks/default
      accessConfigs:
      - name: External NAT
        type: ONE_TO_ONE_NAT
- type: bigquery.v2.dataset
  name: big-query-dataset
  properties:
    datasetReference:
    datasetId:example_id

Determines the number of seconds to wait before checking the job status.

Default: 10

Defines the name of a Connection Profile to use to connect Control-M to Terraform, as described in Terraform Connection Profile Parameters.

Rules:

Case Sensitive

Determines one of the following Terraform actions to perform:

• Create Workspace: Creates a new Terraform workspace.

• Run Workspace: Executes the Terraform workspace.

• Create Variable: Creates a variable in Terraform.

Defines the details of the workspace to create, in JSON format.

{
   "data": 
   {
      "attributes": 
      {
         "name": "WorkspaceFromCM%%ORDERID",
         "terraform_version": "1.3.9",
         "working-directory": "/simple",
         "vcs-repo":
         {
            "identifier": "Reponame/repopoject",
            "oauth-token-id": "ot-RGGGGGGG",
            "branch": "main",
            "default-branch": true
         }
      },
      "type": "workspaces",
      "relationships": 
      {
         "project":
         {
            "data": 
            {
               "type": "projects",
               "id": "prj-AcihyPq2ZQQQQQ"
            }
         }
      }
   }
}

Characters: maximum of 4,000

Defines a name for the workspace where you want to perform the action.

Defines the name of the workspace run in Terraform.

Defines the parameters for this workspace run, in JSON format.

{"key": "ec2_status","value": "\"stopped\""},{"key": "ec2_type","value": "\"small\""}

For no parameters, type {}.

Defines the details of the variable in the Terraform workspace, in JSON format.

{
   "data": 
   {
      "type":"vars",
      "attributes":
      {
         "key":"keydemo",
         "value":"valdemo",
         "description":"testvar",
         "category":"terraform",
         "hcl":false,
         "sensitive":false
      }
   }
}

(Optional) Determines the number of seconds to wait before checking the job status.

Default: 20