CompartmentConfigSource

class oci.resource_manager.models.CompartmentConfigSource(**kwargs)

Bases: oci.resource_manager.models.config_source.ConfigSource

Compartment to use for creating the stack. The new stack will include definitions for supported resource types in this compartment.

Attributes

CONFIG_SOURCE_TYPE_BITBUCKET_CLOUD_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_BITBUCKET_SERVER_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_COMPARTMENT_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_DEVOPS_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_GIT_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_OBJECT_STORAGE_CONFIG_SOURCE str(object=’’) -> str
CONFIG_SOURCE_TYPE_ZIP_UPLOAD str(object=’’) -> str
compartment_id [Required] Gets the compartment_id of this CompartmentConfigSource.
config_source_type [Required] Gets the config_source_type of this ConfigSource.
region [Required] Gets the region of this CompartmentConfigSource.
services_to_discover Gets the services_to_discover of this CompartmentConfigSource.
working_directory Gets the working_directory of this ConfigSource.

Methods

__init__(**kwargs) Initializes a new CompartmentConfigSource 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.
CONFIG_SOURCE_TYPE_BITBUCKET_CLOUD_CONFIG_SOURCE = 'BITBUCKET_CLOUD_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_BITBUCKET_SERVER_CONFIG_SOURCE = 'BITBUCKET_SERVER_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_COMPARTMENT_CONFIG_SOURCE = 'COMPARTMENT_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_DEVOPS_CONFIG_SOURCE = 'DEVOPS_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_GIT_CONFIG_SOURCE = 'GIT_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_OBJECT_STORAGE_CONFIG_SOURCE = 'OBJECT_STORAGE_CONFIG_SOURCE'
CONFIG_SOURCE_TYPE_ZIP_UPLOAD = 'ZIP_UPLOAD'
__init__(**kwargs)

Initializes a new CompartmentConfigSource object with values from keyword arguments. The default value of the config_source_type attribute of this class is COMPARTMENT_CONFIG_SOURCE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • config_source_type (str) – The value to assign to the config_source_type property of this CompartmentConfigSource. Allowed values for this property are: “BITBUCKET_CLOUD_CONFIG_SOURCE”, “BITBUCKET_SERVER_CONFIG_SOURCE”, “COMPARTMENT_CONFIG_SOURCE”, “DEVOPS_CONFIG_SOURCE”, “GIT_CONFIG_SOURCE”, “OBJECT_STORAGE_CONFIG_SOURCE”, “ZIP_UPLOAD”
  • working_directory (str) – The value to assign to the working_directory property of this CompartmentConfigSource.
  • compartment_id (str) – The value to assign to the compartment_id property of this CompartmentConfigSource.
  • region (str) – The value to assign to the region property of this CompartmentConfigSource.
  • services_to_discover (list[str]) – The value to assign to the services_to_discover property of this CompartmentConfigSource.
compartment_id

[Required] Gets the compartment_id of this CompartmentConfigSource. The OCID of the compartment to use for creating the stack. The new stack will include definitions for supported resource types in this compartment.

Returns:The compartment_id of this CompartmentConfigSource.
Return type:str
config_source_type

[Required] Gets the config_source_type of this ConfigSource. The type of configuration source to use for the Terraform configuration.

Allowed values for this property are: “BITBUCKET_CLOUD_CONFIG_SOURCE”, “BITBUCKET_SERVER_CONFIG_SOURCE”, “COMPARTMENT_CONFIG_SOURCE”, “DEVOPS_CONFIG_SOURCE”, “GIT_CONFIG_SOURCE”, “OBJECT_STORAGE_CONFIG_SOURCE”, “ZIP_UPLOAD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The config_source_type of this ConfigSource.
Return type: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.

region

[Required] Gets the region of this CompartmentConfigSource. The region to use for creating the stack. The new stack will include definitions for supported resource types in this region.

Returns:The region of this CompartmentConfigSource.
Return type:str
services_to_discover

Gets the services_to_discover of this CompartmentConfigSource. Filter for services to use with Resource Discovery. For example, “database” limits resource discovery to resource types within the Database service. The specified services must be in scope of the given compartment OCID (tenancy level for root compartment, compartment level otherwise). If not specified, then all services at the scope of the given compartment OCID are used.

Returns:The services_to_discover of this CompartmentConfigSource.
Return type:list[str]
working_directory

Gets the working_directory of this ConfigSource. File path to the directory to use for running Terraform. If not specified, the root directory is used. Required when using a zip Terraform configuration (configSourceType value of ZIP_UPLOAD) that contains folders. Ignored for the configSourceType value of COMPARTMENT_CONFIG_SOURCE. For more information about required and recommended file structure, see File Structure (Terraform Configurations for Resource Manager).

Returns:The working_directory of this ConfigSource.
Return type:str