oci_fleet_apps_management_runbook

This resource provides the Runbook resource in Oracle Cloud Infrastructure Fleet Apps Management service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/fleet-management/latest/Runbook

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/fleet_apps_management

Creates a runbook.

Example Usage

resource "oci_fleet_apps_management_runbook" "test_runbook" {
	#Required
	compartment_id = var.compartment_id
	display_name = var.runbook_display_name
	operation = var.runbook_operation
	runbook_version {
		#Required
		execution_workflow_details {
			#Required
			workflow {
				#Required
				group_name = oci_identity_group.test_group.name
				steps {
					#Required
					type = var.runbook_runbook_version_execution_workflow_details_workflow_steps_type

					#Optional
					group_name = oci_identity_group.test_group.name
					step_name = var.runbook_runbook_version_execution_workflow_details_workflow_steps_step_name
					steps = var.runbook_runbook_version_execution_workflow_details_workflow_steps_steps
				}
				type = var.runbook_runbook_version_execution_workflow_details_workflow_type
			}
		}
		groups {
			#Required
			name = var.runbook_runbook_version_groups_name
			type = var.runbook_runbook_version_groups_type

			#Optional
			properties {
				#Required
				action_on_failure = var.runbook_runbook_version_groups_properties_action_on_failure

				#Optional
				notification_preferences {

					#Optional
					should_notify_on_pause = var.runbook_runbook_version_groups_properties_notification_preferences_should_notify_on_pause
					should_notify_on_task_failure = var.runbook_runbook_version_groups_properties_notification_preferences_should_notify_on_task_failure
					should_notify_on_task_success = var.runbook_runbook_version_groups_properties_notification_preferences_should_notify_on_task_success
				}
				pause_details {
					#Required
					kind = var.runbook_runbook_version_groups_properties_pause_details_kind

					#Optional
					duration_in_minutes = var.runbook_runbook_version_groups_properties_pause_details_duration_in_minutes
				}
				pre_condition = var.runbook_runbook_version_groups_properties_pre_condition
				run_on {
					#Required
					kind = var.runbook_runbook_version_groups_properties_run_on_kind

					#Optional
					condition = var.runbook_runbook_version_groups_properties_run_on_condition
					host = var.runbook_runbook_version_groups_properties_run_on_host
					previous_task_instance_details {

						#Optional
						output_variable_details {

							#Optional
							output_variable_name = var.runbook_runbook_version_groups_properties_run_on_previous_task_instance_details_output_variable_details_output_variable_name
							step_name = var.runbook_runbook_version_groups_properties_run_on_previous_task_instance_details_output_variable_details_step_name
						}
						resource_id = oci_cloud_guard_resource.test_resource.id
						resource_type = var.runbook_runbook_version_groups_properties_run_on_previous_task_instance_details_resource_type
					}
				}
			}
		}
		tasks {
			#Required
			step_name = var.runbook_runbook_version_tasks_step_name
			task_record_details {
				#Required
				scope = var.runbook_runbook_version_tasks_task_record_details_scope

				#Optional
				description = var.runbook_runbook_version_tasks_task_record_details_description
				execution_details {
					#Required
					execution_type = var.runbook_runbook_version_tasks_task_record_details_execution_details_execution_type

					#Optional
					catalog_id = oci_datacatalog_catalog.test_catalog.id
					command = var.runbook_runbook_version_tasks_task_record_details_execution_details_command
					config_file = var.runbook_runbook_version_tasks_task_record_details_execution_details_config_file
					content {
						#Required
						source_type = var.runbook_runbook_version_tasks_task_record_details_execution_details_content_source_type

						#Optional
						bucket = var.runbook_runbook_version_tasks_task_record_details_execution_details_content_bucket
						catalog_id = oci_datacatalog_catalog.test_catalog.id
						checksum = var.runbook_runbook_version_tasks_task_record_details_execution_details_content_checksum
						namespace = var.runbook_runbook_version_tasks_task_record_details_execution_details_content_namespace
						object = var.runbook_runbook_version_tasks_task_record_details_execution_details_content_object
					}
					credentials {

						#Optional
						display_name = var.runbook_runbook_version_tasks_task_record_details_execution_details_credentials_display_name
						id = var.runbook_runbook_version_tasks_task_record_details_execution_details_credentials_id
					}
					endpoint = var.runbook_runbook_version_tasks_task_record_details_execution_details_endpoint
					is_executable_content = var.runbook_runbook_version_tasks_task_record_details_execution_details_is_executable_content
					is_locked = var.runbook_runbook_version_tasks_task_record_details_execution_details_is_locked
					is_read_output_variable_enabled = var.runbook_runbook_version_tasks_task_record_details_execution_details_is_read_output_variable_enabled
					system_variables = var.runbook_runbook_version_tasks_task_record_details_execution_details_system_variables
					target_compartment_id = oci_identity_compartment.test_compartment.id
					variables {

						#Optional
						input_variables {

							#Optional
							description = var.runbook_runbook_version_tasks_task_record_details_execution_details_variables_input_variables_description
							name = var.runbook_runbook_version_tasks_task_record_details_execution_details_variables_input_variables_name
							type = var.runbook_runbook_version_tasks_task_record_details_execution_details_variables_input_variables_type
						}
						output_variables = var.runbook_runbook_version_tasks_task_record_details_execution_details_variables_output_variables
					}
				}
				is_apply_subject_task = var.runbook_runbook_version_tasks_task_record_details_is_apply_subject_task
				is_copy_to_library_enabled = var.runbook_runbook_version_tasks_task_record_details_is_copy_to_library_enabled
				is_discovery_output_task = var.runbook_runbook_version_tasks_task_record_details_is_discovery_output_task
				name = var.runbook_runbook_version_tasks_task_record_details_name
				os_type = var.runbook_runbook_version_tasks_task_record_details_os_type
				platform = var.runbook_runbook_version_tasks_task_record_details_platform
				properties {

					#Optional
					num_retries = var.runbook_runbook_version_tasks_task_record_details_properties_num_retries
					timeout_in_seconds = var.runbook_runbook_version_tasks_task_record_details_properties_timeout_in_seconds
				}
				task_record_id = oci_fleet_apps_management_task_record.test_task_record.id
			}

			#Optional
			output_variable_mappings {
				#Required
				name = var.runbook_runbook_version_tasks_output_variable_mappings_name
				output_variable_details {
					#Required
					output_variable_name = var.runbook_runbook_version_tasks_output_variable_mappings_output_variable_details_output_variable_name
					step_name = var.runbook_runbook_version_tasks_output_variable_mappings_output_variable_details_step_name
				}
			}
			step_properties {
				#Required
				action_on_failure = var.runbook_runbook_version_tasks_step_properties_action_on_failure

				#Optional
				notification_preferences {

					#Optional
					should_notify_on_pause = var.runbook_runbook_version_tasks_step_properties_notification_preferences_should_notify_on_pause
					should_notify_on_task_failure = var.runbook_runbook_version_tasks_step_properties_notification_preferences_should_notify_on_task_failure
					should_notify_on_task_success = var.runbook_runbook_version_tasks_step_properties_notification_preferences_should_notify_on_task_success
				}
				pause_details {
					#Required
					kind = var.runbook_runbook_version_tasks_step_properties_pause_details_kind

					#Optional
					duration_in_minutes = var.runbook_runbook_version_tasks_step_properties_pause_details_duration_in_minutes
				}
				pre_condition = var.runbook_runbook_version_tasks_step_properties_pre_condition
				run_on {
					#Required
					kind = var.runbook_runbook_version_tasks_step_properties_run_on_kind

					#Optional
					condition = var.runbook_runbook_version_tasks_step_properties_run_on_condition
					host = var.runbook_runbook_version_tasks_step_properties_run_on_host
					previous_task_instance_details {

						#Optional
						output_variable_details {

							#Optional
							output_variable_name = var.runbook_runbook_version_tasks_step_properties_run_on_previous_task_instance_details_output_variable_details_output_variable_name
							step_name = var.runbook_runbook_version_tasks_step_properties_run_on_previous_task_instance_details_output_variable_details_step_name
						}
						resource_id = oci_cloud_guard_resource.test_resource.id
						resource_type = var.runbook_runbook_version_tasks_step_properties_run_on_previous_task_instance_details_resource_type
					}
				}
			}
		}

		#Optional
		is_latest = var.runbook_runbook_version_is_latest
		rollback_workflow_details {
			#Required
			scope = var.runbook_runbook_version_rollback_workflow_details_scope
			workflow {
				#Required
				group_name = oci_identity_group.test_group.name
				steps {
					#Required
					type = var.runbook_runbook_version_rollback_workflow_details_workflow_steps_type

					#Optional
					group_name = oci_identity_group.test_group.name
					step_name = var.runbook_runbook_version_rollback_workflow_details_workflow_steps_step_name
					steps = var.runbook_runbook_version_rollback_workflow_details_workflow_steps_steps
				}
				type = var.runbook_runbook_version_rollback_workflow_details_workflow_type
			}
		}
		version = var.runbook_runbook_version_version
	}

	#Optional
	defined_tags = {"foo-namespace.bar-key"= "value"}
	description = var.runbook_description
	estimated_time = var.runbook_estimated_time
	freeform_tags = {"bar-key"= "value"}
	is_default = var.runbook_is_default
	is_sudo_access_needed = var.runbook_is_sudo_access_needed
	os_type = var.runbook_os_type
	platform = var.runbook_platform
}

Argument Reference

The following arguments are supported:

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Runbook * update - (Defaults to 20 minutes), when updating the Runbook * delete - (Defaults to 20 minutes), when destroying the Runbook

Import

Runbooks can be imported using the id, e.g.

$ terraform import oci_fleet_apps_management_runbook.test_runbook "id"