Template

class oci.resource_manager.models.Template(**kwargs)

Bases: object

The properties that define a template. A template is a pre-built Terraform configuration that provisions a set of resources used in a common scenario.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Template.
category_id Gets the category_id of this Template.
compartment_id Gets the compartment_id of this Template.
defined_tags Gets the defined_tags of this Template.
description Gets the description of this Template.
display_name Gets the display_name of this Template.
freeform_tags Gets the freeform_tags of this Template.
id [Required] Gets the id of this Template.
lifecycle_state Gets the lifecycle_state of this Template.
long_description Gets the long_description of this Template.
template_config_source Gets the template_config_source of this Template.
time_created Gets the time_created of this Template.

Methods

__init__(**kwargs) Initializes a new Template object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Template. This constant has a value of “ACTIVE”

__init__(**kwargs)

Initializes a new Template object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this Template.
  • compartment_id (str) – The value to assign to the compartment_id property of this Template.
  • category_id (str) – The value to assign to the category_id property of this Template.
  • display_name (str) – The value to assign to the display_name property of this Template.
  • description (str) – The value to assign to the description property of this Template.
  • long_description (str) – The value to assign to the long_description property of this Template.
  • time_created (datetime) – The value to assign to the time_created property of this Template.
  • template_config_source (oci.resource_manager.models.TemplateConfigSource) – The value to assign to the template_config_source property of this Template.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Template. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Template.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Template.
category_id

Gets the category_id of this Template. Unique identifier for the category where the template is located.

Returns:The category_id of this Template.
Return type:str
compartment_id

Gets the compartment_id of this Template. The OCID of the compartment containing this template.

Returns:The compartment_id of this Template.
Return type:str
defined_tags

Gets the defined_tags of this Template. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:The defined_tags of this Template.
Return type:dict(str, dict(str, object))
description

Gets the description of this Template. Brief description of the template.

Returns:The description of this Template.
Return type:str
display_name

Gets the display_name of this Template. Human-readable name of the template.

Returns:The display_name of this Template.
Return type:str
freeform_tags

Gets the freeform_tags of this Template. Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:The freeform_tags of this Template.
Return type:dict(str, str)
id

[Required] Gets the id of this Template. Unique identifier (OCID) for the template.

Returns:The id of this Template.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Template. The current lifecycle state of the template.

Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Template.
Return type:str
long_description

Gets the long_description of this Template. Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information.

Returns:The long_description of this Template.
Return type:str
template_config_source

Gets the template_config_source of this Template.

Returns:The template_config_source of this Template.
Return type:oci.resource_manager.models.TemplateConfigSource
time_created

Gets the time_created of this Template. The date and time at which the template was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z

Returns:The time_created of this Template.
Return type:datetime