CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails¶

class oci.database_tools_runtime.models.CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails(**kwargs)¶

Bases: object

The content of a Database Tools database API gateway config pool sub resource to be created.

Attributes

`DATABASE_ACTIONS_STATUS_DISABLED`	A constant which can be used with the database_actions_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`DATABASE_ACTIONS_STATUS_ENABLED`	A constant which can be used with the database_actions_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`REST_ENABLED_SQL_STATUS_DISABLED`	A constant which can be used with the rest_enabled_sql_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`REST_ENABLED_SQL_STATUS_ENABLED`	A constant which can be used with the rest_enabled_sql_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`TYPE_DEFAULT`	A constant which can be used with the type property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`advanced_properties`	Gets the advanced_properties of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`database_actions_status`	Gets the database_actions_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`database_tools_connection_id`	[Required] Gets the database_tools_connection_id of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`display_name`	[Required] Gets the display_name of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`initial_pool_size`	Gets the initial_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`jwt_profile_audience`	Gets the jwt_profile_audience of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`jwt_profile_issuer`	Gets the jwt_profile_issuer of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`jwt_profile_jwk_url`	Gets the jwt_profile_jwk_url of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`jwt_profile_role_claim_name`	Gets the jwt_profile_role_claim_name of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`max_pool_size`	Gets the max_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`min_pool_size`	Gets the min_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`pool_route_value`	[Required] Gets the pool_route_value of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`rest_enabled_sql_status`	Gets the rest_enabled_sql_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
`type`	[Required] Gets the type of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails 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.

DATABASE_ACTIONS_STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the database_actions_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “DISABLED”

DATABASE_ACTIONS_STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the database_actions_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “ENABLED”

REST_ENABLED_SQL_STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the rest_enabled_sql_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “DISABLED”

REST_ENABLED_SQL_STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the rest_enabled_sql_status property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “ENABLED”

TYPE_DEFAULT = 'DEFAULT'¶: A constant which can be used with the type property of a CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “DEFAULT”

__init__(**kwargs)¶

Initializes a new CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

CreateDatabaseToolsDatabaseApiGatewayConfigPoolDefaultDetails

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Allowed values for this property are: “DEFAULT”
display_name (str) – The value to assign to the display_name property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
pool_route_value (str) – The value to assign to the pool_route_value property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
database_tools_connection_id (str) – The value to assign to the database_tools_connection_id property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
max_pool_size (int) – The value to assign to the max_pool_size property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
min_pool_size (int) – The value to assign to the min_pool_size property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
initial_pool_size (int) – The value to assign to the initial_pool_size property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_jwk_url (str) – The value to assign to the jwt_profile_jwk_url property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_issuer (str) – The value to assign to the jwt_profile_issuer property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_audience (str) – The value to assign to the jwt_profile_audience property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_role_claim_name (str) – The value to assign to the jwt_profile_role_claim_name property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
database_actions_status (str) – The value to assign to the database_actions_status property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
rest_enabled_sql_status (str) – The value to assign to the rest_enabled_sql_status property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.

advanced_properties¶

Gets the advanced_properties of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Advanced pool properties.

Returns:	The advanced_properties of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	dict(str, str)

database_actions_status¶

Gets the database_actions_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies to enable the Database Actions feature.

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns:	The database_actions_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

database_tools_connection_id¶

[Required] Gets the database_tools_connection_id of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. The OCID of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.

Returns:	The database_tools_connection_id of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

display_name¶

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

Returns:	The display_name of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
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.

initial_pool_size¶

Gets the initial_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the initial size for the number of database connections that will be created for the pool.

Returns:	The initial_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	int

jwt_profile_audience¶

Gets the jwt_profile_audience of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.

Returns:	The jwt_profile_audience of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

jwt_profile_issuer¶

Gets the jwt_profile_issuer of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.

Returns:	The jwt_profile_issuer of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

jwt_profile_jwk_url¶

Gets the jwt_profile_jwk_url of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.

Returns:	The jwt_profile_jwk_url of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

jwt_profile_role_claim_name¶

Gets the jwt_profile_role_claim_name of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.

Returns:	The jwt_profile_role_claim_name of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

max_pool_size¶

Gets the max_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the maximum number of database connections allowed for the pool.

Returns:	The max_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	int

min_pool_size¶

Gets the min_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the minimum number of database connections allowed for the pool.

Returns:	The min_pool_size of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	int

pool_route_value¶

[Required] Gets the pool_route_value of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. The pool route value provided in requests to target this pool.

Returns:	The pool_route_value of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

rest_enabled_sql_status¶

Gets the rest_enabled_sql_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies whether the REST-Enabled SQL service is active.

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns:	The rest_enabled_sql_status of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str

type¶

[Required] Gets the type of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. The type of the Database Tools database API gateway config pool sub resource.

Allowed values for this property are: “DEFAULT”

Returns:	The type of this CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Return type:	str