Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace FusionEnvironmentFamily

Details of a Fusion environment family. An environment family is a logical grouping of environments. The environment family defines a set of characteristics that are shared across the environments to allow consistent management and maintenance across your production, test, and development environments. For more information, see Planning an Environment Family.

Properties

compartmentId

compartmentId: string

The OCID of the compartment where the environment family is located.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.

Optional familyMaintenancePolicy

familyMaintenancePolicy: model.FamilyMaintenancePolicy

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The unique identifier (OCID) of the environment family. Can't be changed after creation.

Optional isSubscriptionUpdateNeeded

isSubscriptionUpdateNeeded: undefined | false | true

When set to True, a subscription update is required for the environment family.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

lifecycleState

lifecycleState: LifecycleState

The current state of the FusionEnvironmentFamily.

subscriptionIds

subscriptionIds: Array<string>

The list of the IDs of the applications subscriptions that are associated with the environment family.

Optional systemName

systemName: undefined | string

Environment Specific Guid/ System Name

Optional timeCreated

timeCreated: Date

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj