otcextensions.sdk.rds.v3.configuration¶

The Configuration Class¶

The Configuration class inherits from Resource.

class otcextensions.sdk.rds.v3.configuration.Configuration(_synchronized=False, connection=None, **attrs)¶

The base resource

Parameters:

_synchronized (bool) – This is not intended to be used directly. See new() and existing().
connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

base_path: str = '/configurations'¶: The base part of the URI for this resource.

resources_key: ty.Optional[str] = 'configurations'¶: Plural form of key for resource.

resource_key: ty.Optional[str] = 'configuration'¶: Singular form of key for resource.

allow_create = True¶: Allow create operation for this resource.

allow_delete = True¶: Allow delete operation for this resource.

allow_commit = True¶: Allow update operation for this resource.

allow_fetch = True¶: Allow get operation for this resource.

allow_list = True¶: Allow list operation for this resource.

configuration_id¶: Id of the configuration group

id¶: Type:str

name: ty.Union[Body, URI]¶: Name of the configuration group Type:str

datastore¶: Data store information Type: dict

description¶: Description of the configuration group Type:str

datastore_version_name¶: Name of Datastore version Type:str

datastore_name¶: Name of Datastore Type:str

configuration_parameters¶: Individual Configuration values Type:dict

created_at¶: Date of created Type:str

updated_at¶: Date of updated Type:str

is_user_defined¶: Indicates whether the parameter group is created by users. Type:bool

values¶: parameter group values defined by users Type: dict

apply_results¶: Results of the configuration apply per instance Type:list

classmethod find(session, name_or_id, ignore_missing=True, **params)¶

Find a resource by its name or id.

Parameters:

session (Adapter) – The session to use for making this request.
name_or_id – This resource’s identifier, if needed by the request. The default is None.
ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
params (dict) – Any additional parameters to be passed into underlying methods, such as to existing() in order to pass on URI parameters.

Returns:

The Resource object matching the given name or id or None if nothing matches.

Raises:

openstack.exceptions.DuplicateResource if more than one resource is found for this request.

Raises:

openstack.exceptions.ResourceNotFound if nothing is found and ignore_missing is False.

create(session, prepend_key=False, base_path=None)¶

Create a remote resource based on this instance.

Parameters:

session (Adapter) – The session to use for making this request.
prepend_key – A boolean indicating whether the resource_key should be prepended in a resource creation request. Default to True.
base_path (str) – Base part of the URI for creating resources, if different from base_path.
resource_request_key (str) – Overrides the usage of self.resource_key when prepending a key to the request body. Ignored if prepend_key is false.
resource_response_key (str) – Overrides the usage of self.resource_key when processing response bodies. Ignored if prepend_key is false.
microversion (str) – API version to override the negotiated one.
params (dict) – Additional params to pass.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_create is not set to True.

commit(session, prepend_key=False, **further_attrs)¶

Commit the state of the instance to the remote resource.

Parameters:

session (Adapter) – The session to use for making this request.
prepend_key – A boolean indicating whether the resource_key should be prepended in a resource update request. Default to True.
retry_on_conflict (bool) – Whether to enable retries on HTTP CONFLICT (409). Value of None leaves the Adapter defaults.
base_path (str) – Base part of the URI for modifying resources, if different from base_path.
microversion (str) – API version to override the negotiated one.
kwargs (dict) – Parameters that will be passed to _prepare_request()

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_commit is not set to True.

apply(session, instances)¶: Apply configuration to the given instances

last updated: 2024-05-18 00:15