CreateOnboardConfigDetails¶
- class oci.stack_monitoring.models.CreateOnboardConfigDetails(**kwargs)¶
Bases:
CreateConfigDetailsA configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.
Methods:
__init__(**kwargs)Initializes a new CreateOnboardConfigDetails object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
Attributes:
Gets the additional_configurations of this CreateOnboardConfigDetails.
[Required] Gets the compartment_id of this CreateConfigDetails.
[Required] Gets the config_type of this CreateConfigDetails.
Gets the defined_tags of this CreateConfigDetails.
Gets the display_name of this CreateConfigDetails.
Gets the dynamic_groups of this CreateOnboardConfigDetails.
Gets the freeform_tags of this CreateConfigDetails.
[Required] Gets the is_manually_onboarded of this CreateOnboardConfigDetails.
Gets the policy_names of this CreateOnboardConfigDetails.
Gets the user_groups of this CreateOnboardConfigDetails.
Gets the version of this CreateOnboardConfigDetails.
- __init__(**kwargs)¶
Initializes a new CreateOnboardConfigDetails object with values from keyword arguments. The default value of the
config_typeattribute of this class isONBOARDand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
display_name (str) – The value to assign to the display_name property of this CreateOnboardConfigDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateOnboardConfigDetails.
config_type (str) – The value to assign to the config_type property of this CreateOnboardConfigDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOnboardConfigDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOnboardConfigDetails.
version (str) – The value to assign to the version property of this CreateOnboardConfigDetails.
is_manually_onboarded (bool) – The value to assign to the is_manually_onboarded property of this CreateOnboardConfigDetails.
policy_names (list[str]) – The value to assign to the policy_names property of this CreateOnboardConfigDetails.
dynamic_groups (list[oci.stack_monitoring.models.DynamicGroupDetails]) – The value to assign to the dynamic_groups property of this CreateOnboardConfigDetails.
user_groups (list[oci.stack_monitoring.models.GroupDetails]) – The value to assign to the user_groups property of this CreateOnboardConfigDetails.
additional_configurations (oci.stack_monitoring.models.AdditionalConfigurationDetails) – The value to assign to the additional_configurations property of this CreateOnboardConfigDetails.
- property additional_configurations¶
Gets the additional_configurations of this CreateOnboardConfigDetails.
- Returns
The additional_configurations of this CreateOnboardConfigDetails.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this CreateConfigDetails. Compartment in which the configuration is created.
- Returns
The compartment_id of this CreateConfigDetails.
- Return type
str
- property config_type¶
[Required] Gets the config_type of this CreateConfigDetails. The type of configuration.
- Returns
The config_type of this CreateConfigDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateConfigDetails. 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 CreateConfigDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CreateConfigDetails. The display name of the configuration.
- Returns
The display_name of this CreateConfigDetails.
- Return type
str
- property dynamic_groups¶
Gets the dynamic_groups of this CreateOnboardConfigDetails. List of dynamic groups dedicated for Stack Monitoring.
- Returns
The dynamic_groups of this CreateOnboardConfigDetails.
- Return type
- property freeform_tags¶
Gets the freeform_tags of this CreateConfigDetails. 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 CreateConfigDetails.
- Return type
dict(str, str)
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property is_manually_onboarded¶
[Required] Gets the is_manually_onboarded of this CreateOnboardConfigDetails. True if customer decides marks configuration as manually configured.
- Returns
The is_manually_onboarded of this CreateOnboardConfigDetails.
- Return type
bool
- property policy_names¶
Gets the policy_names of this CreateOnboardConfigDetails. List of policy names assigned for onboarding
- Returns
The policy_names of this CreateOnboardConfigDetails.
- Return type
list[str]
- property user_groups¶
Gets the user_groups of this CreateOnboardConfigDetails. List of user groups dedicated for Stack Monitoring.
- Returns
The user_groups of this CreateOnboardConfigDetails.
- Return type
- property version¶
Gets the version of this CreateOnboardConfigDetails. Assigned version to given onboard configuration.
- Returns
The version of this CreateOnboardConfigDetails.
- Return type
str