FusionEnvironmentFamily¶

class oci.fusion_apps.models.FusionEnvironmentFamily(**kwargs)¶

Bases: object

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.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily.
`compartment_id`	[Required] Gets the compartment_id of this FusionEnvironmentFamily.
`defined_tags`	Gets the defined_tags of this FusionEnvironmentFamily.
`display_name`	[Required] Gets the display_name of this FusionEnvironmentFamily.
`family_maintenance_policy`	Gets the family_maintenance_policy of this FusionEnvironmentFamily.
`freeform_tags`	Gets the freeform_tags of this FusionEnvironmentFamily.
`id`	[Required] Gets the id of this FusionEnvironmentFamily.
`is_subscription_update_needed`	Gets the is_subscription_update_needed of this FusionEnvironmentFamily.
`lifecycle_details`	Gets the lifecycle_details of this FusionEnvironmentFamily.
`lifecycle_state`	[Required] Gets the lifecycle_state of this FusionEnvironmentFamily.
`subscription_ids`	[Required] Gets the subscription_ids of this FusionEnvironmentFamily.
`system_name`	Gets the system_name of this FusionEnvironmentFamily.
`time_created`	Gets the time_created of this FusionEnvironmentFamily.

Methods

__init__(**kwargs) Initializes a new FusionEnvironmentFamily object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a FusionEnvironmentFamily. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new FusionEnvironmentFamily 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 FusionEnvironmentFamily.
display_name (str) – The value to assign to the display_name property of this FusionEnvironmentFamily.
family_maintenance_policy (oci.fusion_apps.models.FamilyMaintenancePolicy) – The value to assign to the family_maintenance_policy property of this FusionEnvironmentFamily.
compartment_id (str) – The value to assign to the compartment_id property of this FusionEnvironmentFamily.
subscription_ids (list[str]) – The value to assign to the subscription_ids property of this FusionEnvironmentFamily.
is_subscription_update_needed (bool) – The value to assign to the is_subscription_update_needed property of this FusionEnvironmentFamily.
time_created (datetime) – The value to assign to the time_created property of this FusionEnvironmentFamily.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FusionEnvironmentFamily. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this FusionEnvironmentFamily.
system_name (str) – The value to assign to the system_name property of this FusionEnvironmentFamily.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FusionEnvironmentFamily.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FusionEnvironmentFamily.

compartment_id¶

[Required] Gets the compartment_id of this FusionEnvironmentFamily. The OCID of the compartment where the environment family is located.

Returns:	The compartment_id of this FusionEnvironmentFamily.
Return type:	str

defined_tags¶

Gets the defined_tags of this FusionEnvironmentFamily. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

display_name¶

[Required] Gets the display_name of this FusionEnvironmentFamily. A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.

Returns:	The display_name of this FusionEnvironmentFamily.
Return type:	str

family_maintenance_policy¶

Gets the family_maintenance_policy of this FusionEnvironmentFamily.

Returns:	The family_maintenance_policy of this FusionEnvironmentFamily.
Return type:	oci.fusion_apps.models.FamilyMaintenancePolicy

freeform_tags¶

Gets the freeform_tags of this FusionEnvironmentFamily. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

id¶

[Required] Gets the id of this FusionEnvironmentFamily. The unique identifier (OCID) of the environment family. Can’t be changed after creation.

Returns:	The id of this FusionEnvironmentFamily.
Return type:	str

is_subscription_update_needed¶

Gets the is_subscription_update_needed of this FusionEnvironmentFamily. When set to True, a subscription update is required for the environment family.

Returns:	The is_subscription_update_needed of this FusionEnvironmentFamily.
Return type:	bool

lifecycle_details¶

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

Returns:	The lifecycle_details of this FusionEnvironmentFamily.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this FusionEnvironmentFamily. The current state of the FusionEnvironmentFamily.

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

Returns:	The lifecycle_state of this FusionEnvironmentFamily.
Return type:	str

subscription_ids¶

[Required] Gets the subscription_ids of this FusionEnvironmentFamily. The list of the IDs of the applications subscriptions that are associated with the environment family.

Returns:	The subscription_ids of this FusionEnvironmentFamily.
Return type:	list[str]

system_name¶

Gets the system_name of this FusionEnvironmentFamily. Environment Specific Guid/ System Name

Returns:	The system_name of this FusionEnvironmentFamily.
Return type:	str

time_created¶

Gets the time_created of this FusionEnvironmentFamily. The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

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