CreateCompartmentDetails

class oci.identity.models.CreateCompartmentDetails(**kwargs)

Bases: object

CreateCompartmentDetails model.

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this CreateCompartmentDetails.
  • name (str) -- The value to assign to the name property of this CreateCompartmentDetails.
  • description (str) -- The value to assign to the description property of this CreateCompartmentDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateCompartmentDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateCompartmentDetails.
compartment_id

[Required] Gets the compartment_id of this CreateCompartmentDetails. The OCID of the parent compartment containing the compartment.

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

Gets the defined_tags of this CreateCompartmentDetails. 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 CreateCompartmentDetails.
Return type:dict(str, dict(str, object))
description

[Required] Gets the description of this CreateCompartmentDetails. The description you assign to the compartment during creation. Does not have to be unique, and it's changeable.

Returns:The description of this CreateCompartmentDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateCompartmentDetails. Free-form tags for this resource. Each tag is a simple 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 CreateCompartmentDetails.
Return type:dict(str, str)
name

[Required] Gets the name of this CreateCompartmentDetails. The name you assign to the compartment during creation. The name must be unique across all compartments in the parent compartment. Avoid entering confidential information.

Returns:The name of this CreateCompartmentDetails.
Return type:str