Compute Resources (A-L)
Summaries and Attributes of InsightCloudSec Compute Resources
Compute Resources - Now Two Pages
Due to the enormous quantity of information contained on these pages we have divided the content for Compute resources into two pages.
The current page contains resource information for resources in the "Compute" category, along with their related attributes for resources (InsightCloudSec-normalized name) names beginning with the letters A through L.
For resources beginning with the letters M through Z refer to: Compute Resources (M-Z)
Compute Resources are available in InsightCloudSec as the first section (tab) under the Resource landing page. These resources are related to compute functionality and include resources like app servers, instances, and elastic search instances.
Compute resources are displayed alphabetically using the InsightCloudSec normalized terminology. Hovering over an individual resource provides the CSP-specific terminology with the associated logo to help users confirm the displayed information. For example, an Autoscaling Group refers to Amazon's "Autoscaling Group", Google's "Autoscalers", and Azure's "Virtual Machine Scale Sets".
For a detailed reference of this normalized terminology check out our Resource Terminology.
Compute Resources
A Note About Resource Attributes
A large number of Resource Attributes are offered for the resources outlined here. Because we are continuously expanding our supported resources the attributes and details included here can not be guaranteed to include every resource or every attribute.
If you need information about the attributes of a particular resource we are happy to help get those details for you - reach out to us through the Customer Support Portal with any questions!
Airflow Environment
Airflow Environments offers managed orchestration service for Apache Airflow - an open-source tool used to programmatically author, schedule, and monitor sequences of processes and tasks referred to as workflows.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region in which the Airflow Environment resides |
| name | The name of the Airflow Environment |
| arn | The ARN associated with the Airflow Environment |
| create_time | The time when this Airflow Environment was created |
| version | The version of the Airflow Environment |
| environment_class | The environment class, e.g., 'mw1.small' |
| max_workers | The maximum number of workers allowed with this Airflow Environment |
| status | The status of the Airflow Environment (e.g., available) |
| logging_configuration | A description of the logging configuration, including TaskLogs, WorkerLogs, and SchedulerLogs |
| encrypted | Denotes whether the Airflow Environment is encrypted |
| key_resource_id | The provider ID of Encryption Key (if encrypted) |
| execution_role_resource_id | The resource ID for the execution role |
| service_role_resource_id | The resource ID for the service role |
| webserver_access_mode | The webserver access mode, e.g., public only |
| webserver_url | The URL for the webserver |
| relationships | A list of resources associated with the Airflow Environment |
App Configurations
App Configurations provide a means to centrally manage application settings and feature flags.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| config_id | The provider ID for the configuration |
| name | The name of the configuration |
| resource_group | The name of the resource group the configuration is associated with |
| provisioning_state | The provisioning state of the configuration |
| region_name | The name of the region in which the configuration resides |
| sku | The pricing tier of the configuration |
| purge_protection_enabled | Indicates if purge protection is enabled for the configuration |
| public_network_access | The network access configuration of the configuration |
| automatic_network_setting | Indicates if public network access on the resource is set to the automatic setting |
| creation_date | The date the configuration was created |
| soft_delete_retention_days | The number of days the configuration will be retained if deleted |
| encrypted_with_cmk | Indicates if the configuration is encrypted using a customer key |
| identity_type | The type of identity assigned to the configuration |
| disable_local_auth | Indicates if local authentication is disabled for a configuration |
| endpoint | The endpoint of the configuration |
| private_endpoint_connections | The number of endpoints attached to the configuration |
| namespace_id | The fully qualified ID of the resource, including the resource name and resource type |
App Server
App Servers are the underlying virtual machines that host Azure App Services. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region in which this App Server resides |
| app_server_id | The provider ID of the App Server |
| name | The name of the App Server |
| server_type | The type of the App Server (F1 Free, B1 Basic, S1 Standard, etc) |
| instance_count | The number of instances running this app |
| max_instance_count | The maximum number of instances for running the app |
| app_count | The number of apps running on the App Server |
| state | The state of the App Server (ready, stopped, etc) |
App Stream Fleet
An App Stream Fleet is a managed application streaming service that streams desktop applications to users.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region in which the App Stream Fleet resides |
| arn | The ARN associated with the App Stream Fleet |
| name | The name of the App Stream Fleet |
| image_name | The image name associated with the App Stream Fleet |
| image_arn | The ARN associated with the image for the App Stream Fleet |
| instance_type | The type of instance used by the App Stream Fleet |
| instance_flavor_resource_id | The Resource ID for the instance flavor used by the App Stream Fleet |
| fleet_type | The type of Fleet for the App Stream |
| compute_status | Status of compute resources for the App Stream Fleet |
| max_user_duration | The maximum duration (in seconds) for users |
| disconnect_timeout | The timeout (in seconds) for a user to disconnect |
| state | The state of the App Stream Fleet |
| creation_date | The date and timestamp for the creation of the App Stream Fleet |
| default_internet_access | Indicates whether default internet access is enabled for the fleet |
| domain_joined | Indicates whether the Fleet is associated with a directory domain |
| role_resource_id | The Resource ID for the role associated with the Fleet |
| stream_view | The stream view displayed to users while using the Fleet |
| platform | The platform of the Fleet |
| session_script_s3 | Describes the S3 session script |
| relationships | List of resources associated with the Fleet |
Autoscaling Group
Autoscaling Groups contain a collection of Instances that share similar characteristics and are treated as a logical grouping for the purposes of instance scaling and management. The Autoscaling Group class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| group_id | The provider ID of the autoscaling group |
| name | The name of the autoscaling group |
| arn | The ARN associated with the autoscaling group |
| create_time | The time when this autoscaling group was created |
| region_name | The region in which this autoscaling group resides |
| health_check_grace_period | The amount of time (in seconds) that the autoscaling group will wait to run the system health check, after instances have been started |
| min_size | The minimum number of instances running at all times on this autoscale group |
| max_size | The maximum number of instances that can be running at any time on this autoscale group |
| desired_capacity | The desired amount of instances running at all times in the autoscaling group |
| new_instance_protection | The instances that are protected from termination during scale in |
| default_cooldown | The amount of time the autoscaling group will wait before resuming scaling activities |
| multi_az | Denotes if the group is multi AZ |
| suspended_processes | The JSON value of suspended processes |
| vm_profile | The JSON value of the profile of the machine |
| spot_instances | Whether the autoscaling group will utilize spot instances |
| upgrade_policy | Describes the upgrade policy settings for the autoscaling group |
| launch_configuration | The launch configuration that is associated with the autoscaling group |
| launch_template | A launch template that is associated with the autoscaling group |
| warm_pool_size | The number of warm pool instances configured |
| warm_pool_instances | The type of instances in the warm pool |
| load_balancers | A list of classic load balancers that are associated with the autoscaling group |
| target_group | A list of application target groups that are associated with the autoscaling group |
| vulnerability_sources | The vulnerability source (requires IVM agent integration) |
class DivvyResource.Resources.autoscalinggroup.AutoscalingGroup(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Autoscaling Group Operations
delete(user_resource_id=None)
Not now available for use.
static get_db_class()
get_instances()
Retrieve the instance members the group uses.
static get_provider_id_field()
static get_resource_type()
get_subnets()
Retrieve the subnets the group operates in.
get_supported_actions()
Retrieve all the actions which are supported by this resource.
group
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to projects/groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from projects/groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session This gives an opportunity for post-modification hooks.
has_attached_instance()
Return True is instance(s) are attached to asg.
modify(max_size=None, min_size=None, user_resource_id=None)
Modify the Autoscaling group. This makes a call sot he upstream providier to change one or more properties.
name
provider_id
top_level_resource = True
Autoscaling Launch Configuration
Autoscaling Launch Configurations are templates that autoscaling groups use to launch instances.
This class inherits from TopLevelResource and has direct access to the resource's database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region the Autoscaling Launch Configuration resides in |
| image_id | The provider ID of image instances are launched from |
| name | The name of the autoscaling launch configuration |
| arn | The Amazon resource name of the autoscaling launch configuration |
| instance_type | The type of instance to launch |
| spot_price | The maximum hourly price to be paid for any spot instance launched from autoscaling launch configuration |
| identity_management_role | The role associated with the autoscaling launch configuration |
| creation_timestamp | The time autoscaling launch configuration was created |
| monitoring | Denotes if detailed monitoring is enabled on instances launched from autoscaling launch configuration (true/false) |
| kernel_id | The ID of the kernel associated with the Image |
| ram_id | The ID of the RAM disk to select |
| associate_ip | Denotes whether to assign a public IP address to each instance |
| block_storage_optimized | Denotes whether the launch configuration is optimized for I/O (true) or not (false) |
| role_resource_id | The resource ID of the role performing the autoscaling |
| user_data | The user data to make available to the launched instances using this configuration |
| sensitive_data | Indicates if the launch configuration contains sensitive data within the user data |
| contains_secret | Indicates if the launch configuration contains a Secret within the user data |
Batch Environment
An environment containing many compute nodes that can run large-scale parallel and high-performance computing batch jobs efficiently, e.g., Azure Batch Account, AWS Batch Compute Environment.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| name | The name of the Batch Environment |
| region_name | The region in which the Batch Environment resides |
| namespace_id | The fully qualified ID of the resource, including the resource name and resource type |
| state | The state of the Batch Environment |
| endpoint | The endpoint where the Batch Environment is accessible |
| public_access | Whether public access is enabled for the Batch Environment |
| allocation_type | The allocation type for the Batch Environment |
| minimum_cpus | The minimum amount of CPUs allocated for the Batch Environment |
| maximum_cpus | The maximum amount of CPUs allocated for the Batch Environment |
| storage_account_resource_id | The resource ID for the storage account associated with the Batch Environment |
| encryption | The encryption enabled for the Batch Environment |
| pool_type | The type of instance pool within the Batch Environment |
| role_resource_id | The resource identifier for the role allocated to the Batch Environment. |
Batch Pool
A group of compute nodes that is used in a batch environment to run large-scale parallel and high-performance computing batch jobs efficiently, e.g., Azure Batch Pool.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| name | The name of the Batch Pool |
| region_name | The region in which the Batch Pool resides |
| namespace_id | The fully qualified ID of the resource, including the resource name and resource type |
| environment_resource_id | The ID for the Batch Pool's parent Batch Environment |
| last_modified | The most recent time the Batch Pool was modified |
| state | The state of the Batch Pool |
| vm_size | The size of the virtual machine(s) within the Batch Pool |
| autoscaling | Whether the Batch Pool has autoscaling enabled |
| inter_node_communication | Whether the Batch Pool has internode communication enabled |
| subnet_resource_id | The resource ID of the subnet in which the Batch Pool is running, if known |
Big Data Instance
Big Data Instances are database instances which store and process big data. An example of this type of instance is AWS Redshift. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region that the instance resides in |
| instance_id | The provider ID of the instance |
| name | The name of the instance |
| instance_type | The type of instance |
| instance_flavor_resource_id | The resource ID of the type (flavor) this instance runs on |
| state | The state of the big data instance |
| create_time | The time the instance was created |
| availability_zone | The zone where the big data instance lives |
| endpoint_address | The FQDN of the big data instance |
| endpoint_port | The port that the big data instance listens on |
| nodes | The number of nodes in the cluster |
| version | The software version the big data instance leverages |
| allow_version_upgrade | Denotes whether the instance has automatic version upgrades enabled |
| db_name | The name of the master database |
| subnet_group_name | The database subnet group name that the instance uses |
| vpc_id | The database VPC ID that the instance uses |
| backup_retention | An integer representing the number of days that automatic snapshots are retained for |
| master_username | The username of the master user |
| encrypted | Denotes if the data stored on the instance is encrypted |
| key_resource_id | The provider ID of Encryption Key (if encrypted) |
| publicly_accessible | Denotes if the instance can be accessed over the Internet |
| access_lists | The list of associated security groups |
| instance_flavor | The returned flavor of a object which contains information on the size of the instance |
| ssl_required | Denotes if SSL is required (true/false) |
| fips_required | Denotes if FIPS compliant SSL mode is required |
| logging | Boolean value on whether a Big Data Instance is logging |
| logging_bucket | The location of the Storage Container the Big Data Instance is logging to, if known |
| parameter_groups | The parameter group(s) associated with the instance |
class DivvyResource.Resources.bigdatainstance.BigDataInstance(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Big Data Instance Operations
delete(wait_for_result=True, user_resource_id=None)
Delete this resource. If wrapped in a with JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
static get_db_class()
get_instance_type()
Retrieve the instance type of the resource.
static get_provider_id_field()
static get_resource_type()
get_state()
Retrieve the instance state.
get_supported_actions()
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to projects/groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None, project_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from projects/groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session. This gives an opportunity for post-modification hooks.
`instance
top_level_resource = True
Big Data Serverless Namespace
A Big Data Serverless Namespace is a collection of database objects and users.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| namespace_id | The provider-specific namespace ID value |
| name | The name of the namespace resource |
| db_name | The database name associated with the namespace |
| region_name | The region in which the namespace is located |
| state | The status of the namespace |
| arn | The ARN value associated with the namespace |
| role_resource_id | Denotes the IAM role associated with the namespace |
| admin_username | Denotes the admin username associated with the namespace |
| key_resource_id | Denotes the key associated with the namespace |
| log_exports | Denotes the log export configurations for the namespace |
| creation_date | The date the namespace was created |
Big Data Serverless Workgroup
A Big Data Serverless Workgroup is a collection of compute resources.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| namespace_id | The provider-specific namespace ID value |
| organization_service_id | The ID of the parent organization service (cloud) |
| workgroup_id | The ID associated with the workgroup |
| name | The name of the workgroup resource |
| region_name | The region in which the workgroup is located |
| state | The status of the workgroup |
| arn | The ARN value associated with the workgroup |
| vpc_endpoints | The count of VPC endpoints attached to the workgroup |
| creation_date | The date the workgroup was created |
| base_capacity | The base capacity of the workgroup |
| enhanced_routing | Denotes whether the workgroup has enhanced routing enabled |
| publicly_accessible | Denotes whether the workgroup is publicly accessible |
| relationships | List of resources associated with the workgroup |
Big Data Workspace
Big Data Workspace comprises data integration, data warehousing, and big data analytics functionality. An example of a Big Data Workspace is an Azure Synapse resource.
| Attribute | Description |
|---|---|
| name | The name of the workspace |
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| workspace_id | The provider ID of the workspace |
| region_name | The region in which the workspace resides |
| state | The state of the big data workspace (e.g., Succeeded) |
| double_encryption_enabled | Denotes if double encryption is enabled (true/false) |
| workspace_type | The type of workspace (e.g., Normal) |
| sql_administrator_login | Login name for the SQL administrator |
| scope_enabled | Denotes whether scope is enabled (true/false) |
| public_access | Denotes whether access is public (true/false) |
Build Project
Build Project configures how source code is built, e.g., where to obtain the code and which build environment to use.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region that the Build Project resides in |
| project_id | The Project ID associated with the Build Project |
| name | The name of the Build Project |
| description | The description associated with the Build Project |
| creation_date | The creation date of the Build Project |
| build_type | The type of repository that contains the source code to be built |
| privilege_mode | Denotes if the Build Project is running in privileged mode |
| cache_type | The type of cache used by the Build Project |
| encrypted | Denotes whether the Build Project is encrypted or not |
| role_resource_id | The Resource ID of the associated service Role, if applicable |
| key_resource_id | The Resource ID of the encryption key, if applicable |
| network_resource_id | The Resource ID of the associated VPC, if applicable |
| logging_bucket | The details of the bucket where logs are being sent, if applicable |
| log_group_name | The logging group name, if applicable |
| arn | The Amazon Resource Name (ARN) of the Build Project |
| build_image | The image the Build Project is using |
| clear_text_credentials | Indicates if the Build Project contains credentials in clear text |
| contains_secret | Indicates if the Build Project contains a secret |
Cache Database Cluster
A Cache Database Cluster is an in-memory database service that provides fast performance and durability, e.g., AWS MemoryDB.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region in which the Cache Database Cluster resides |
| name | The name of the Cache Database Cluster |
| description | Text description for the Cache Database Cluster |
| state | The state of the Cache Database Cluster |
| number_of_shards | The number of shards in the cluster |
| multi_az | Denotes if the cluster can be in multiple availability zones |
| endpoint_address | The fully-qualified domain name for the Cache Database Cluster |
| endpoint_port | The port that the Cache Database Cluster listens on |
| instance_type | The type of instance being used to host Cache Database Cluster |
| engine_version | The version of the engine currently installed |
| nodes | The number of nodes in the cluster |
| parameter_group | The name of the parameter group associated with the Cache Database Cluster |
| subnet_group | The subnet associated with the Cache Database Cluster |
| transit_encryption | Boolean value indicating if transit encryption is enabled |
| key_resource_id | The resource ID of the associated encryption key |
| arn | The ARN associated with the Cache Database Cluster |
| backup_retention | An integer representing the number of days that automatic snapshots are retained for |
| auto_minor_upgrades | Denotes if this instance automatically takes minor upgrades or not |
Cache Instance
Memcache Instances are managed systems with one or more caching technologies installed, e.g., Redis. Examples of this would be AWS Elasticache and Azure Redis. This class inherits from TopLevelResource and has direct access to the resource's database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| instance_type | The type of instance |
| region_name | The region that the instance resides in |
| instance_id | The provider ID of the instance |
| name | The name of the instance |
| instance_flavor_resource_id | The resource ID of the type (flavor) this is instance runs on |
| state | The state the instance is in (ready/available/normal/running) |
| availibilty_zone | The availability zone this instance runs in |
| endpoint_address | The FQDN of the instance |
| endpoint_port | The port that the instance listens on |
| engine | The engine that the database uses (redis/memcached) |
| engine_version | The install version of the engine |
| backup_retention | The integer representing the number of days that automatic snapshots are retained for |
| nodes | The number of nodes |
| create_time | The time the instance was created |
| at_rest_encryption_enabled | Denotes if at rest encryption is enabled (true/false) |
| transit_encryption_enabled | Denotes if transit encryption is enabled (true/false) |
| auth_token_enabled | Denotes if AuthToken is enabled (true/false) |
| auth_token_last_modified | The last time the AuthToken was modified |
| reserved_ip_range | The range of IP addresses reserved |
| network_resource_id | The provider ID of network this instance is in |
| key_resource_id | The ID of the encryption key used to encrypt this Instance |
| replication_group_id | The ID of the associated replication group, if applicable |
| automatic_failover | Denotes if automatic failover is enabled |
| namespace_id | The fully qualified ID of the resource, including the resource name and resource type |
| public_network_access | Denotes if public network access to this Cache Instance is enabled |
| relationships | List of relationships between the Cache Instance and other services |
Connect Instance
Connect instances provide virtual call center capabilities to your customers.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region in which the Connect Instance resides. |
| alias | The user-provided alias |
| namespace_id | The namespace ID for the Connect Instance |
| instance_id | The provider-specific ID value |
| id_management_type | Identity management type of the instance |
| status | The status of the instance |
| role_resource_id | The role used by the instance |
| inbound_enabled | Denotes if inbound calls are enabled |
| outbount_enabled | Denotes if outbound calls are enabled |
| create_time | The time the instance was created |
| enabled_features | List of enabled features for the connect instance |
| feature_configuration | The feature configuration object for the connect instance |
Database
Databases that reside within database instances. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region that the database resides in |
| database_id | The provider ID of the database |
| name | The name of the database |
| instance_resource_id | The provider ID of the associated instance |
| collation | The implemented collation set for the database |
| character_set | The character set of the database |
| create_time | The creation time of the database |
| encrypted | The encryption status of the database |
| key_resource_id | The provider ID of the encryption key, if applicable |
| database_type | The underlying database type |
class DivvyResource.Resources.database.Database(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Database Operations
database
delete(user_resource_id=None)
Delete this resource. If wrapped in a with JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
static get_db_class()
static get_provider_id_field()
static get_resource_type()
get_state()
Retrieve the route state.
get_supported_actions()
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to groups, alerts, etc.).
top_level_resource = True
Database Cluster
A database cluster is one or more database instances connected together to simulate a single system. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region that the cluster resides in |
| create_time | The time the cluster was created |
| cluster_id | The provider ID of the cluster |
| db_name | The name of the master database |
| db_subnet_group | The subnet group associated with the DB cluster |
| state | The state that the cluster is in (available, stopped, etc) |
| earliest_restorable_time | The earliest time to which a database can be restored with point-in-time restore |
| latest_restorable_time | The latest time to which a database can be restored with point-in-time restore. |
| endpoint | The connection endpoint for the primary instance of the DB cluster |
| multi_az | Denotes whether or not the cluster is set up for high availability and is distributed across multiple zones |
| availability_zones | The zone(s) where the cluster lives |
| engine | The engine that the database uses (mysql, neptune, docdb, etc.) |
| engine_version | The version of the engine |
| port | The port that the database engine is listening on |
| backup_retention | The number of days for which automatic DB snapshots are retained |
| db_cluster_resource_id | The resource ID of the cluster |
| namespace_id | ARN (Amazon Resource Name) of the cluster |
| deletion_protection | Denotes if deletion protection is enabled on the cluster |
| read_replica | Denotes if the cluster is a read replica |
| parameter_group | The name of the DB cluster parameter group for the DB cluster |
| option_groups | The option group(s) associated with the database cluster |
| storage_encrypted | Boolean denoting if the cluster is encrypted |
| key_resource_id | The encryption Key for the cluster (if applicable) |
| capacity | The current capacity of the cluster |
| min_capacity | The minimum capacity of the cluster |
| max_capacity | The maximum capacity of the cluster |
| master_username | The master username for the cluster |
| iam_authentication | Boolean value indicating whether IAM authentication is used |
| enabled_logging_types | The list of the currently enabled logging levels, if applicable (e.g. audit, error, general) |
| stream_name | The name of the data stream used for the database activity stream |
| stream_key_id | The key ID used for encrypting messages in the database activity stream |
| stream_mode | The mode for the database activity stream |
| stream_status | The status of the database activity stream |
| copy_tags_to_snapshot | Denotes whether or not the database is configured to copy tags to snapshots |
| enhanced_monitoring | Denotes whether or not the database is configured for enhanced monitoring |
| maintenance_actions | The maintenance actions associated with the cluster |
| preferred_maintenance_window | The preferred window of time in which maintenance should be performed |
| preferred_backup_window | The preferred window of time in which a backup should be created |
| relationships | A list of resources associated with the cluster |
Database Event Subscription
Database event subscriptions allow notifications when events within an event category occur.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region where the event subscription instance resides |
| event_subscription_id | The numerical ID InsightCloudSec assigns each Event Subscription |
| status | The status of the Subscription |
| enabled | Denotes whether the Subscription is enabled or not |
| topic_resource_id | The Resource ID of the Subscription Topic |
| namespace_id | The ARN of the Subscription |
| source_type | The Source type |
| source_ids | ID's of the Source(s) |
| categories | Categories of the Subscription |
| created_time | The time of creation |
Database Instance
Database Instances are managed systems with one or more relational database management software components installed. Examples of this include: AWS RDS, Azure SQL, and Google Cloud SQL. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| instance_type | The type of instance |
| region_name | The region that the instance resides in |
| instance_id | The provider ID of the instance |
| name | The name of the instance |
| instance_flavor_resource_id | The resource ID of the type (flavor) this is instance runs on |
| state | The state that the instance is in |
| endpoint_address | The FQDN of the instance |
| endpoint_port | The port that the instance listens on |
| engine | The engine that the database uses, e.g., mysq |
| engine_version | The install version of the engine |
| storage_size | The size in gigabytes allocated to the instance |
| max_storage_size | The maximum size (in gigabytes) of the instance |
| storage_autoscaling | Denotes whether the instance is configured to autoscale its storage size |
| storage_type | The storage type that is used |
| db_name | The name of the master database |
| backup_retention | An integer representing the number of days that automatic snapshots are retained |
| latest_restorable_time | The latest restorable time of the instance |
| multi_az | Denotes whether or not this system is set up for high availability and is distributed across multiple zones |
| license | The type of license associated with this instance |
| master_username | The username of the master user |
| create_time | The time this instance was created |
| encrypted | Denotes if the data stored on the instance is encrypted |
| encryption_type | The type of encryption enabled on the instance |
| transit_encryption | Boolean value indicating if transit encryption is enabled |
| publicly_accessible | Denotes if the instance can be accessed over the Internet |
| reserved | Boolean value indicating if this is a reserved Database Instance type |
| key_resource_id | The resource ID of the associated encryption key, if applicable |
| read_replica | Denotes if the instance is a read replica |
| network_resource_id | The Resource ID of the associated network, if known |
| auto_minor_upgrades | Denotes if this instance automatically takes minor upgrades |
| users | The user information, if known |
| deletion_protection | Denotes if this database enforces deletion protection |
| database_cluster_resource_id | The Resource ID of the associated database cluster, if applicable |
| iam_authentication | Denotes if this database enforces IAM authentication |
| enabled_logging_types | The enabled logging types for the database |
| ca_cert | The CA certificate associated with this database |
| managed_instance | Denotes whether or not the database is managed by the CSP |
| minimal_tls_version | The TLS version configured on the database instance |
| parameter_groups | The parameter group(s) associated with the database instance |
| option_groups | The option group(s) associated with the database instance |
| flags | The enabled logging types for the database instance |
| public_network_access | Public network access information for the database instance (if publicly accessible) |
| private_endpoint_connections | Boolean indicating if private endpoint connections are enabled for the database instance |
| namespace_id | The unique composite ID of the provider ID for the database instance |
| maintenance_actions | The maintenance actions associated with the database instance |
| preferred_maintenance_window | The preferred maintenance window (in days of the week & time hours/minutes) for the database instance |
| preferred_backup_window | The preferred backup creation window (in time hours/minutes) for the database instance |
| copy_tags_to_snapshot | Denotes whether or not the database is configured to copy tags to snapshots |
| enhanced_monitoring | Denotes whether or not the database is configured for enhanced monitoring |
| flexible | Indicates if the database instance is flexible |
| relationships | List of relationships between the database instance and other services |
| backup_retention_enabled | Denotes whether backup retention is enabled |
| performance_insights_enabled | Denotes whether performance insights are enabled |
class DivvyResource.Resources.databaseinstance.DatabaseInstance(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Database Instance Operations
db_instance
delete(wait_for_result=True, user_resource_id=None)
Delete this resource. If wrapped in a with JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
get_date_created()
Retrieve the time from the provider that this resource was created (if available).
static get_db_class()
get_instance_type()
Retrieve the instance type of the resource.
static get_provider_id_field()
static get_resource_type()
get_snapshots()
Retrieve a list of db objects for snapshots created within from this database instance (if any).
get_state()
Retrieve the database instance state.
get_supported_actions()
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from projects/groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session. This gives an opportunity for post-modification hooks.
top_level_resource = True
Dataflow Job
Unified stream and batch data processing job.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| job_id | The ID for the job |
| name | The name for the job |
| type | The type of job |
| state | The state of the job |
| current_state_time | The duration the job has been in its current state |
| default_service_account | The default service account associated with the job |
| public_worker_ips | The public worker IP addresses associated with the job |
| shuffle_mode | The type of shuffle mode currently enabled for the job |
| region_name | The region in which the job resides |
| job_metadata | Metadata associated with the job |
| create_time | The time the job was created |
| start_time | The time the job started |
Distributed Table
Distributed Tables are NoSQL database tables. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| table_id | The provider ID of the distributed table |
| region_name | The region that this table resides in |
| name | The name of this distributed table |
| status | The status of this table (Creating, active, etc.) |
| size | The size in bytes of the table |
| arn | The Amazon Resource Name of this table |
| encryption_at_rest | Boolean value of whether or not this table is encrypted at rest |
| item_count | The count of how many items are in this table |
| create_time | The time when this distributed table was created |
| read_capacity | The maximum number of strongly consistent reads consumed per second |
| write_capacity | The maximum number of writes consumed per second |
| stream_specification | Boolean value denoting whether or not this table has stream specification enabled |
| replicated_regions | The regions where read-replicas exist |
| automated_backups | Denotes if automated backups are enabled |
| publicly_accessible | Denotes if the instance can be accessed over the Internet |
| default_consistency_level | The default consistency level for the table |
| key_resource_id | The Resource ID of the associated encryption key, if known |
| table_class | The configured class for the table |
| billing_mode | The billing mode enabled for the table |
| termination_protection | Denotes whether the distributed table has termination protection enabled |
class DivvyResource.Resources.distributedtable.DistributedTable(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Distributed Table Operations
delete(user_resource_id=None)
Delete this resource. If wrapped with a JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
distributed_table
distributed_table_id
get_date_created()
static get_db_class()
static get_provider_id_field()
static get_resource_type()
get_supported_actions()
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session. This gives an opportunity for post-modification hooks.
top_level_resource = True
Distributed Table Cluster
Distributed Table Clusters are fully managed, highly available, in-memory cache for Distributed Tables. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region is which the distributed table cluster resides |
| name | The name of the distributed table cluster |
| description | The optional description associated with the distributed table cluster |
| creation_timestamp | The creation time of the distributed table cluster |
| node_count | The number of nodes in this cluster |
| node_ids | The JSON value of node IDs |
| instance_type | The type of instance the distributed table cluster is attached to |
| instance_flavor_resource_id | The flavor of instance used by the distributed table cluster |
| network_resource_id | The network provider ID of the distributed table cluster |
| parameter_group | The parameter group for the distributed table cluster |
| maintenance_window | The maintenance window for the distributed table cluster |
| status | The status of the distributed table cluster |
| endpoint_address | The endpoint address for the distributed table cluster |
| endpoint_port | The endpoint port for the distributed table cluster |
| arn | The Amazon Resource Name of the distributed table cluster |
| availability_zones | The availability zone(s) of the distributed table cluster |
| role_resource_id | The Role provider ID for the distributed table cluster |
| encrypted | Denotes whether the cluster supports at rest encryption |
| transit_encryption | Denotes whether the cluster supports in transit encryption |
class DivvyResource.Resources.distributedtablecluster.DistributedTableCluster(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Distributed Table Cluster Operations
distributed_table_cluster
get_date_created()
static get_db_class()
static get_provider_id_field()
static get_resource_type()
get_status()
get_supported_actions()
top_level_resource = True
DLP Job
DLP Jobs are individual data loss prevention (DLP) scans.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| job_id | The unique ID for the job |
| name | The name of the job |
| type | The type of the job |
| state | The current state of the job |
| region_name | The name of the region in which the job resides |
| trigger_name | The name of the trigger for the job |
| info_types | The list of information types that the job detects |
| min_likelihood | The required level of confidence that scanned data is of a certain information type |
| deidentify_template | The name of the de-identify template used to anonymize results |
| actions | The list of actions taken upon job completion |
| findings | List of information types found during the job |
| create_time | The create time for the job |
| start_time | The start time for the job |
| end_time | The end time for the job |
| namespace_id | The unique composite ID of the provider ID for the resource |
Elasticsearch Instance
An Elasticsearch Instance (AWS OpenSearch) is a restful search and analytics engine. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| instance_type | The type of the elasticsearch instance |
| region_name | The region where this elasticsearch instance resides |
| instance_id | The provider ID of the elasticsearch instance |
| name | The name of this elasticsearch instance |
| instance_flavor_resource_id | The resource ID of the type (flavor) this is instance runs on |
| network_resource_id | The resource ID of the parent (network) |
| state | The state of this elasticsearch instance |
| endpoint | The location where you can access your elasticsearch instance |
| version | The version of elasticsearch this instance is using |
| nodes | The number of nodes in this elasticsearch cluster |
| policy | The JSON of the access policy attached to this elasticsearch instance |
| at_rest_encryption_enabled | Denotes if encryption is enabled on the elasticsearch instance |
| trusted_accounts | The trusted accounts that can interact with the queue |
| public_access | Denotes if the instance is publicly accessible |
| node_to_node_encryption | The encrypted communication between nodes |
| transit_encryption | The Enforcement of SSL communication between the client/server |
| tls_security_policy | The TLS security policy used |
| key_resource_id | The resource ID of the encryption key, if applicable |
| zone_awareness_enabled | Denotes whether availability zone awareness is enabled |
| warm_enabled | Denotes whether warm storage is enabled |
| advanced_security_options | JSON of advanced security options configuration for the Elasticsearch Instance |
| availability_zones | The number of availability zones the resource will use |
| unknown_accounts | List of unknown accounts that can interact with the Elasticsearch instance |
| service_software_current_version | Denotes the current service software version |
| service_software_new_version | Denotes the latest service software version |
| service_software_upgrade_eligible | Denotes whether the Elasticsearch instance is eligible for a software upgrade and has not scheduled to upgrade yet |
| service_software_update_status | Denotes status of a service software version update |
class DivvyResource.Resources.elasticsearchinstance.ElasticsearchInstance(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Elasticsearch Instance Operations
delete(wait_for_result=True, user_resource_id=None)
Delete this resource. If wrapped in a with JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
static get_db_class()
get_instance_type()
Retrieve the instance type of the resource.
static get_provider_id_field()
static get_resource_type()
get_state()
Retrieve the instance state.
get_supported_actions()
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to projects/groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from projects/groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session This gives an opportunity for post-modification hooks.
instance
top_level_resource = True
Elasticsearch Serverless Collection
Serverless option for OpenSearch Service for running large-scale search and analytics workloads without managing clusters. (For example: AWS OpenSearch Serverless).
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| collection_id | The provider-specific collection id value |
| name | The collection name |
| state | The state of the collection |
| type | The collection type |
| description | The collection description |
| collection_endpoint | The collection endpoint |
| dashboard_endpoint | The collection dashboard endpoint |
| public_access | Denotes if the collection is accessible over the Internet |
| policy | The policy associated with the collection |
| network_policy | The network policy associated with the collection |
| encryption_policy | The encryption policy associated with the collection |
| key_resource_id | The KMS key that the collection is associated with (optional) |
| creation_date | The time when the collection was created |
Email Service Config
Email Service Configs are groups of rules applied to the verified identities that are used to send email through a cloud email service.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| name | The name of the configuration |
| region_name | The region in which the configuration resides |
| destinations | The list of destinations where emails will be sent |
| tls_enforced | Determines if the incoming email is required to be delivered over a connection encrypted with TLS |
| sending_enabled | Denotes if email sending is enabled |
| arn | The provider-specific ID for the email configuration set |
Email Service Domain
Email Service Domains are identity domains within cloud email services. This class inherits from TopLevelResource and has direct access to the resource's database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region where the Email Service Domain resides |
| name | The name of the Email Service Domain |
| verification_status | Specifies whether or not the Domain is verified; you can only send email from verified domains |
| dkim_status | Denotes the current status of DKIM for the domain; statuses include PENDING, SUCCESS, FAILED, TEMPORARY_FAILURE, NOT_STARTED |
| dkim_enabled | Denotes if DKIM signing is enabled or not |
| policies | A map of policy names to policies |
| mail_from_domain | The name of a domain that an email identity uses as a custom MAIL FROM domain |
| mail_from_status | The status of the MAIL FROM domain. Values include PENDING, SUCCESS, FAILED, TEMPORARY_FAILURE |
| forwarding_enabled | Denotes if feedback forwarding configuration is enabled or not |
| bounce_topic | The SNS topic for Bounce events, if applicable |
| complaint_topic | The SNS topic for Complaint events, if applicable |
| delivery_topic | The SNS topic for Delivery events, if applicable |
| identity_type | The identity type |
Email Service Rule
Email Service Rules are part of Rule sets and inform how to handle incoming email by executing an specified list of actions.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The name of the region in which the rule resides |
| name | The name of the email service rule |
| rule_set_name | The name of the rule set the rule is associated with |
| enabled | Denotes whether the rule is enabled |
| scan_enabled | Denotes whether the messages this rule is applied to are scanned for viruses and spam |
| tls_enforced | Denotes if the incoming email is required to be delivered over a connection encrypted with TLS |
| recipients | Domains and email addresses the rule applies to |
| actions | List of actions to perform on messages |
Event Grid Topic
Event Grid topics act as a receiving endpoint for a collection of related events.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| name | The name of the topic |
| resource_group | The name of the resource group that the topic will be associated with |
| provisioning_state | The provisioning state of the topic |
| public_network_access | The network access configuration of the topic |
| topic_id | The ID of the topic |
| region_name | The region in which the topic resides |
| namespace_id | The provider-specific namespace ID value |
HSM Cluster
A hardware security module (HSM) cluster providers users with an easy way to generate and manage encryption keys within a cloud service provider (CSP) environment.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region where the cluster is deployed |
| cluster_id | The provider ID for the cluster |
| creation_time | The timestamp for when the cluster was created |
| status | The status of the cluster |
| backup_retention | The backup retention in days of the cluster |
| network_resource_id | The private network that the cluster is associated with |
| hsm_count | Total number of instances in the cluster |
| hsms | Information about hardware security modules within the cluster |
| relationships | Information about the cluster's relationships |
Hypervisor
Hypervisors are responsible for housing virtual machines/instances. This resource inherits from Resource and has direct access to the resource’s database object.
| Attribute | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region where the hypervisor lives |
| hypervisor_id | The provider ID of the hypervisor |
| name | The name of the hypervisor |
| address | The IP address of the hypervisor |
| port | The port the hypervisor listens on |
| hypervisor_type | The type of hypervisor |
| hypervisor_version | The hypervisor version |
| state | The lifecycle state of the hypervisor |
| availability_zone | The availability zone where the hypervisor lives |
| instances | The list of instances running on this hypervisor |
| time_configuration | The JSON value of the time configuration for the hypervisor |
class DivvyResource.Resources.hypervisor.Hypervisor(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Hypervisor Operations
static get_db_class()
static get_provider_id_field()
get_resource_dependencies()
Retrieve the dependencies for a particular resources. For hypervisors we also need to include datastores which requires flipping the ResourceLink relationship.
static get_resource_type()
get_supported_actions()
Retrieve all the actions which are supported by this resource.
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session. This gives an opportunity for post-modification hooks.
hypervisor
hypervisor_id
top_level_resource = True
Instance
Compute Instances are virtual private servers. Examples of include AWS EC2 and Azure Virtual Machines. This class inherits from TopLevelResource and has direct access to the resource’s database object.
| Attributes | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| instance_id | The provider ID of the instance |
| organization_service_id | The ID of the parent organization service (cloud) |
| instance_type | The type of instance |
| instance_flavor_resource_id | The resource ID of the type (flavor) this is instance runs on |
| state | The state that the instance is in |
| state_transition_reason | The reason the instance is in its current state |
| name | The name of the instance |
| region_name | The region that the instance resides in |
| availability_zone | The availability zone where this instance runs |
| launch_time | The time the instance was launched (started) |
| create_time | The time the instance was created |
| platform | The platform the system runs on (linux/windows) |
| root_device_type | Denotes the root device storage type |
| root_device_name | The name of the root device |
| image_id | The ID of the image used to create this instance |
| key_name | The name of the key pair used for this instance |
| public_ip_address | The public IP address of this instance |
| private_ip_address | The private IP address of this instance |
| role_resource_id | The resource ID of the role associated with the instance |
| role_name | The name of the role associated with the instance |
| tenancy | Type of tenancy: dedicated or default |
| reserved | Denotes if the instance is reserved or not |
| network_resource_id | The list of attached network interfaces |
| termination_protection | Denotes whether or not the instance has termination protection enabled |
| project_wide_ssh | Denotes if the instance has project wide SSH enabled |
| connecting_serial_ports | Denotes if the instance has connecting serial ports |
| ip_forwarding | Denotes if the instance has IP forwarding enabled |
| spot_instance | Denotes if the instance is a spot instance or not |
| detailed_monitoring | Denotes if detailed monitoring is enabled |
| hibernation_supported | Denotes if this instance supports hibernation or not |
| subnet_resource_id | The resource ID of the subnet in which the instance is running, if known |
| aws_instance_metadata_service_config | The AWS instance metadata service config map |
| shielded_config | The shielded instance configuration map |
| enable_os_login | If the OS Login capability is enabled on the instance |
| jit_access_policy | The Just-in-time access policy map |
| architecture | The structural PC architecture for the instance |
| instance_group | The group that the instance is part of |
| outpost_resource_id | If enabled, ID for the Outpost resource associated with the instance |
| object_id | The object ID for the instance |
| ssm_last_accessed | The timestamp for when the instance was last accessed by the Systems Manager |
| ssm_last_accessed_by | The role ARN that used the Systems Manager to access the instance |
| secondary_private_ip_addresses | The secondary private IP address of this instance |
| secondary_public_ip_addresses | The secondary public IP address of this instance |
| namespace_id | The ID for the instance's namespace |
| contains_secret | Indicates if the instance contains a Secret within user data |
| parent_resource_id | Indicates the parent resource ID if the instance is part of an autoscaling group |
| confidential_computing | Denotes if confidential computing is enabled |
| relationships | A list of resources associated with the instance |
class DivvyResource.Resources.instance.Instance(resource_id)
Bases: DivvyResource.Resources.toplevelresource.TopLevelResource
Instance Operations
add_instance_to_app(name)
Add instance to App
delete(user_resource_id=None, force_delete=False, wait_for_result=True)
Delete this resource. If wrapped in a with JobQueue() block, this will queue the deletion job to the wrapped queue, otherwise it calls immediately.
Parameters: force_delete – If set this will work around termination protection (if the cloud supports it). An example of this is AWS.
Returns: bool
get_aggregate_cost()
Retrieve monthly cost and sum the attached volumes in order to factor into total costs.
get_attached_ips()
Retrieve all ip addresses - public and private - associated with this instance.
get_attached_network_interfaces()
Retrieve a list of db object for interfaces which are attached to this instance (if any). DEPRECATED - Used instance.network_interfaces.
get_attached_networks()
Retrieve all networks this instance is attached to.
get_attached_private_ips()
Retrieve private ip addresses which are attached to this instance (if any).
get_attached_public_ips()
Retrieve public ip objects which are attached to this instance (if any).
get_attached_volumes()
Retrieve a list of db object for volumes which are attached to this instance (if any).
get_availability_zone()
Retrieve the name of the availability zone.
get_date_created()
Retrieve the time from the provider that this resource was created. By default this will return the beginning date of epoch if no such create time exists.
static get_db_class()
get_image()
Retrieve the image that the instance uses. If the instance was deleted upstream or if we have not harvested it yet then this could return None.
get_image_id()
Retrieve the image ID of the resource.
get_image_name()
Retrieve the image name that the instance uses. If the instance was deleted upstream or if we have not harvested it yet then this could return None.
get_instance_type()
Retrieve the instance type of the resource.
get_primary_network_interface_id()
Return the network interface attached to eth0 (device index 0).
static get_provider_id_field()
get_resource_dependencies()
Retrieve the dependencies for a particular resources. This is an override of the parent function because we need to reverse the order on our resource lookups.
static get_resource_type()
get_security_groups()
Retrieve security groups which are associated with this instance.
get_supported_actions()
Retrieve all the actions which are supported by this resource.
Restricts actions by resource state.
handle_resource_created(user_resource_id=None, project_resource_id=None)
This should be called when a resource is created/discovered after the basic data is added to the database. This gives an opportunity for post-addition hooks (assignment to projects/groups, alerts, etc.).
handle_resource_destroyed(user_resource_id=None)
This should be called when a resource is destroyed before the basic data is removed from the database. This gives an opportunity for pre-destruction hooks (removal from projects/groups, alerts, etc.).
handle_resource_modified(resource, *args, **kwargs)
This should be called when a resource is modified after the new data has been updated in the DB session. This gives an opportunity for post-modification hooks.
instance
instance_id
is_attached_to_asg()
Return True if instance is attached to Auto Scale Group.
organization_service_id
pause()
Pause this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
region_name
remove_instance_from_app()
Remove instance from app.
restart()
Restart this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
resume()
Restart this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
shelve()
Stop this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
start()
Start this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
stop()
Stop this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
suspend()
Suspend this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
top_level_resource = True
unpause()
Unpause this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
unshelve()
Stop this instance. It is wrapped in a with JobQueue() block, this will queue the stop job to the wrapped queue.
uses_simple_networking()
Determine whether this instance supports only instance-based simple networking. i.e. EC2-classic networking or nova-network.
Launch Template
A launch template contains configuration information for an instance so that it can be launched in a consistently reproducible way.
| Attributes | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The region where the launch template is located |
| image_id | The provider ID for the launch template |
| name | The name of the launch template |
| description | A description for the launch template |
| instance_type | The type of instance in the launch template |
| instance_flavor_resource_id | The provider resource ID for the instance flavor |
| identity_management_role | The identity management role associated with the instance |
| role_resource_id | The resource ID for the role associated with the launch template |
| creation_timestamp | The timestamp for when the launch template was created |
| monitoring | Denotes whether detailed monitoring is enabled |
| kernel_id | The ID for the kernel associated with the machine image |
| ram_id | The ID of the RAM disk associated with the machine image |
| associate_ip | Indicates whether to assign a public IP to each instance associated with the launch template |
| contains_secret | Indicates if the launch template contains a Secret within the user data |
| user_data | The user data to make available to the launched instances using this template |
| block_storage_optimized | Indicates whether the instance is optimized for block storage |
| version | The version of the launch template |
| relationships | Any relationships associated with the launch template |
Logic App
Integration platform as a service that promotes scale and portability while offering critical workflow automation from a workspace of any size.
| Attributes | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| organization_service_id | The ID of the parent organization service (cloud) |
| region_name | The name of the region |
| app_id | The cloud provider ID for the Logic App |
| name | The name for the Logic App |
| state | The current state of the Logic App |
| create_time | Timestamp for when the Logic App was created |
| changed_time | Timestamp for when the Logic App was last modified |
| access_endpoint | URL used to access the Logic App |
| connectors | List of connectors enabled for the Logic App |
| plan | The type of plan for the Logic App |
| web_app_resource_id | The web app resource ID associated with the Logic App |
Lightsail
Lightsail provides developers compute, storage, and networking capacity and capabilities to deploy and manage websites and web applications in the cloud.
| Attributes | Description |
|---|---|
| resource_id | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
| region_name | The name of the region |
| organization_service_id | The ID of the parent organization service (cloud) |
| lightsail_id | The provider ID of the Lightsail instance |
| name | The name of the Lightsail instance |
| arn | The ARN of the Lightsail instance |
| provider_resource_type | The resource type associated with this Lightsail instance (e.g., Relational Database, Load Balancer, Container Service) |
| size | The size of the Lightsail instance |
| engine | The engine the Lightsail instance uses (e.g., mysql 8.0.21, HTTP) |
| create_time | The creation time of the Lightsail instance |
| state | The state of the instance |
| publicly_accessible | Boolean value denoting whether the instance is publicly accessible |
| resource_properties | Properties of the Lightsail instance |
Updated 6 months ago