Instance¶

class oci.pss.models.Instance(**kwargs)¶

Bases: object

A Public Safety and Security instance.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Instance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Instance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Instance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Instance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Instance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Instance.
`admin_identity_domain_user_id`	[Required] Gets the admin_identity_domain_user_id of this Instance.
`compartment_id`	[Required] Gets the compartment_id of this Instance.
`defined_tags`	[Required] Gets the defined_tags of this Instance.
`display_name`	[Required] Gets the display_name of this Instance.
`freeform_tags`	[Required] Gets the freeform_tags of this Instance.
`id`	[Required] Gets the id of this Instance.
`identity_domain_url`	[Required] Gets the identity_domain_url of this Instance.
`identity_domain_web_auth_client_id`	Gets the identity_domain_web_auth_client_id of this Instance.
`identity_domain_web_auth_client_secret_vault_id`	Gets the identity_domain_web_auth_client_secret_vault_id of this Instance.
`lifecycle_details`	Gets the lifecycle_details of this Instance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Instance.
`public_ip`	Gets the public_ip of this Instance.
`service_endpoint`	Gets the service_endpoint of this Instance.
`system_tags`	[Required] Gets the system_tags of this Instance.
`time_created`	[Required] Gets the time_created of this Instance.
`time_updated`	Gets the time_updated of this Instance.
`ui_endpoint`	Gets the ui_endpoint of this Instance.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new Instance 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 Instance.
display_name (str) – The value to assign to the display_name property of this Instance.
compartment_id (str) – The value to assign to the compartment_id property of this Instance.
identity_domain_url (str) – The value to assign to the identity_domain_url property of this Instance.
identity_domain_web_auth_client_id (str) – The value to assign to the identity_domain_web_auth_client_id property of this Instance.
identity_domain_web_auth_client_secret_vault_id (str) – The value to assign to the identity_domain_web_auth_client_secret_vault_id property of this Instance.
admin_identity_domain_user_id (str) – The value to assign to the admin_identity_domain_user_id property of this Instance.
public_ip (str) – The value to assign to the public_ip property of this Instance.
service_endpoint (str) – The value to assign to the service_endpoint property of this Instance.
ui_endpoint (str) – The value to assign to the ui_endpoint property of this Instance.
time_created (datetime) – The value to assign to the time_created property of this Instance.
time_updated (datetime) – The value to assign to the time_updated property of this Instance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Instance. 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 Instance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Instance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Instance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Instance.

admin_identity_domain_user_id¶

[Required] Gets the admin_identity_domain_user_id of this Instance. The OCID of the identity-domain user that initially administers the PSS instance.

Returns:	The admin_identity_domain_user_id of this Instance.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this Instance. The OCID of the compartment.

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

defined_tags¶

[Required] Gets the defined_tags of this Instance. 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 Instance.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this Instance. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

[Required] Gets the freeform_tags of this Instance. 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 Instance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Instance. The OCID of the Instance.

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

identity_domain_url¶

[Required] Gets the identity_domain_url of this Instance. The URL of the identity domain associated with the instance.

Example: https://idcs-1234567890.identity.oraclecloud.com

Returns:	The identity_domain_url of this Instance.
Return type:	str

identity_domain_web_auth_client_id¶

Gets the identity_domain_web_auth_client_id of this Instance. The client ID of the identity-domain confidential application used for browser authentication.

Returns:	The identity_domain_web_auth_client_id of this Instance.
Return type:	str

identity_domain_web_auth_client_secret_vault_id¶

Gets the identity_domain_web_auth_client_secret_vault_id of this Instance. The OCID of the Vault secret containing the identity-domain confidential application’s client secret.

Returns:	The identity_domain_web_auth_client_secret_vault_id of this Instance.
Return type:	str

lifecycle_details¶

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

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

lifecycle_state¶

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

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 Instance.
Return type:	str

public_ip¶

Gets the public_ip of this Instance. The public IP address for the instance’s API gateway.

Returns:	The public_ip of this Instance.
Return type:	str

service_endpoint¶

Gets the service_endpoint of this Instance. The HTTPS endpoint for the instance’s PSS API.

Example: https://example.pss.oraclecloud.com/api/

Returns:	The service_endpoint of this Instance.
Return type:	str

system_tags¶

[Required] Gets the system_tags of this Instance. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“example-key”: “example-value”}}

Returns:	The system_tags of this Instance.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Instance. The date and time the Instance was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this Instance. The date and time the Instance was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this Instance.
Return type:	datetime

ui_endpoint¶

Gets the ui_endpoint of this Instance. The HTTPS endpoint for the instance’s PSS user interface.

Example: https://example.pss.oraclecloud.com/ui/

Returns:	The ui_endpoint of this Instance.
Return type:	str