Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Template

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.

Properties

Optional categoryId

categoryId: undefined | string

Unique identifier for the category where the template is located. Possible values are {@code 0} (Quick Starts), {@code 1} (Service), {@code 2} (Architecture), and {@code 3} (Private).

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing this template.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

Brief description of the template.

Optional displayName

displayName: undefined | string

Human-readable name of the template.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

Unique identifier (OCID) for the template.

Optional isFreeTier

isFreeTier: undefined | false | true

whether the template will work for free tier tenancy.

Optional lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the template.

Optional longDescription

longDescription: undefined | string

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

Optional templateConfigSource

templateConfigSource: model.TemplateZipUploadConfigSource

Optional timeCreated

timeCreated: Date

The date and time at which the template was created. Format is defined by RFC3339. Example: {@code 2020-11-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Template): object

getJsonObj