scaleway.redis.v1 package

Submodules

scaleway.redis.v1.api module

class scaleway.redis.v1.api.RedisV1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Managed Databases for Redis™.

add_acl_rules(*, cluster_id: str, acl_rules: List[ACLRuleSpec], zone: Optional[str] = None) → AddAclRulesResponse

Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster). :param cluster_id: UUID of the Database Instance you want to add ACL rules to. :param acl_rules: ACLs rules to add to the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: AddAclRulesResponse

Usage:

result = api.add_acl_rules(
    cluster_id="example",
    acl_rules=[],
)

add_cluster_settings(*, cluster_id: str, settings: List[ClusterSetting], zone: Optional[str] = None) → ClusterSettingsResponse

Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the name and the value of each setting. :param cluster_id: UUID of the Database Instance you want to add settings to. :param settings: Settings to add to the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ClusterSettingsResponse

Usage:

result = api.add_cluster_settings(
    cluster_id="example",
    settings=[],
)

add_endpoints(*, cluster_id: str, endpoints: List[EndpointSpec], zone: Optional[str] = None) → AddEndpointsResponse

Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add private_network or public_network specifications to the body of the request. :param cluster_id: UUID of the Database Instance you want to add endpoints to. :param endpoints: Endpoints to add to the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: AddEndpointsResponse

Usage:

result = api.add_endpoints(
    cluster_id="example",
    endpoints=[],
)

create_cluster(*, version: str, node_type: str, zone: Optional[str] = None, project_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, user_name: str, password: str, tls_enabled: bool, cluster_size: Optional[int] = None, acl_rules: Optional[List[ACLRuleSpec]] = None, endpoints: Optional[List[EndpointSpec]] = None, cluster_settings: Optional[List[ClusterSetting]] = None) → Cluster

Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the zone, project_id, version, node_type, user_name and password parameters. Optionally you can define acl_rules, endpoints, tls_enabled and cluster_settings. :param version: Redis™ engine version of the Database Instance. :param node_type: Type of node to use for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :param project_id: Project ID in which to create the Database Instance. :param name: Name of the Database Instance. :param tags: Tags to apply to the Database Instance. :param user_name: Name of the user created upon Database Instance creation. :param password: Password of the user. :param tls_enabled: Defines whether or not TLS is enabled. :param cluster_size: Number of nodes in the Redis™ cluster. :param acl_rules: List of ACLRuleSpec used to secure your publicly exposed cluster. :param endpoints: Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default. :param cluster_settings: List of advanced settings to be set upon Database Instance initialization. :return: Cluster

Usage:

result = api.create_cluster(
    version="example",
    node_type="example",
    user_name="example",
    password="example",
    tls_enabled=False,
)

delete_acl_rule(*, acl_id: str, zone: Optional[str] = None) → Cluster

Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule you want to delete in your request. :param acl_id: UUID of the ACL rule you want to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_acl_rule(
    acl_id="example",
)

delete_cluster(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the region and cluster_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. :param cluster_id: UUID of the Database Instance to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_cluster(
    cluster_id="example",
)

delete_cluster_setting(*, cluster_id: str, setting_name: str, zone: Optional[str] = None) → Cluster

Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body. :param cluster_id: UUID of the Database Instance where the settings must be set. :param setting_name: Setting name to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_cluster_setting(
    cluster_id="example",
    setting_name="example",
)

delete_endpoint(*, endpoint_id: str, zone: Optional[str] = None) → Cluster

Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the region and endpoint_id parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. :param endpoint_id: UUID of the endpoint you want to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_endpoint(
    endpoint_id="example",
)

get_acl_rule(*, acl_id: str, zone: Optional[str] = None) → ACLRule

Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule in your request. :param acl_id: UUID of the ACL rule you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ACLRule

Usage:

result = api.get_acl_rule(
    acl_id="example",
)

get_cluster(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.get_cluster(
    cluster_id="example",
)

get_cluster_certificate(*, cluster_id: str, zone: Optional[str] = None) → ScwFile

Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ScwFile

Usage:

result = api.get_cluster_certificate(
    cluster_id="example",
)

get_cluster_metrics(*, cluster_id: str, zone: Optional[str] = None, start_at: Optional[datetime] = None, end_at: Optional[datetime] = None, metric_name: Optional[str] = None) → ClusterMetricsResponse

Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the start_date and end_date. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :param start_at: Start date. :param end_at: End date. :param metric_name: Name of the metric to gather. :return: ClusterMetricsResponse

Usage:

result = api.get_cluster_metrics(
    cluster_id="example",
)

get_endpoint(*, endpoint_id: str, zone: Optional[str] = None) → Endpoint

Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response. :param endpoint_id: UUID of the endpoint you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Endpoint

Usage:

result = api.get_endpoint(
    endpoint_id="example",
)

list_cluster_versions(*, include_disabled: bool, include_beta: bool, include_deprecated: bool, zone: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListClusterVersionsResponse

List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as include_disabled, include_beta, include_deprecated and version. :param include_disabled: Defines whether or not to include disabled Redis™ engine versions. :param include_beta: Defines whether or not to include beta Redis™ engine versions. :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: List Redis™ engine versions that match a given name pattern. :param page: :param page_size: :return: ListClusterVersionsResponse

Usage:

result = api.list_cluster_versions(
    include_disabled=False,
    include_beta=False,
    include_deprecated=False,
)

list_cluster_versions_all(*, include_disabled: bool, include_beta: bool, include_deprecated: bool, zone: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[ClusterVersion]

List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as include_disabled, include_beta, include_deprecated and version. :param include_disabled: Defines whether or not to include disabled Redis™ engine versions. :param include_beta: Defines whether or not to include beta Redis™ engine versions. :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: List Redis™ engine versions that match a given name pattern. :param page: :param page_size: :return: List[ClusterVersion]

Usage:

result = api.list_cluster_versions_all(
    include_disabled=False,
    include_beta=False,
    include_deprecated=False,
)

list_clusters(*, zone: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListClustersRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListClustersResponse

List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags, name, organization_id and version. :param zone: Zone to target. If none is passed will use default zone from the config. :param tags: Filter by Database Instance tags. :param name: Filter by Database Instance names. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by Project ID. :param organization_id: Filter by Organization ID. :param version: Filter by Redis™ engine version. :param page: :param page_size: :return: ListClustersResponse

Usage:

result = api.list_clusters()

list_clusters_all(*, zone: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListClustersRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Cluster]

List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags, name, organization_id and version. :param zone: Zone to target. If none is passed will use default zone from the config. :param tags: Filter by Database Instance tags. :param name: Filter by Database Instance names. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by Project ID. :param organization_id: Filter by Organization ID. :param version: Filter by Redis™ engine version. :param page: :param page_size: :return: List[Cluster]

Usage:

result = api.list_clusters_all()

list_node_types(*, include_disabled_types: bool, zone: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNodeTypesResponse

List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param include_disabled_types: Defines whether or not to include disabled types. :param zone: Zone to target. If none is passed will use default zone from the config. :param page: :param page_size: :return: ListNodeTypesResponse

Usage:

result = api.list_node_types(
    include_disabled_types=False,
)

list_node_types_all(*, include_disabled_types: bool, zone: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[NodeType]

List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param include_disabled_types: Defines whether or not to include disabled types. :param zone: Zone to target. If none is passed will use default zone from the config. :param page: :param page_size: :return: List[NodeType]

Usage:

result = api.list_node_types_all(
    include_disabled_types=False,
)

migrate_cluster(*, cluster_id: str, zone: Optional[str] = None, version: Optional[str] = None, node_type: Optional[str] = None, cluster_size: Optional[int] = None) → Cluster

Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint. :param cluster_id: UUID of the Database Instance to update. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: Redis™ engine version of the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :param node_type: Type of node to use for the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :param cluster_size: Number of nodes for the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :return: Cluster

Usage:

result = api.migrate_cluster(
    cluster_id="example",
)

renew_cluster_certificate(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.renew_cluster_certificate(
    cluster_id="example",
)

set_acl_rules(*, cluster_id: str, acl_rules: List[ACLRuleSpec], zone: Optional[str] = None) → SetAclRulesResponse

Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster). :param cluster_id: UUID of the Database Instance where the ACL rules have to be set. :param acl_rules: ACLs rules to define for the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: SetAclRulesResponse

Usage:

result = api.set_acl_rules(
    cluster_id="example",
    acl_rules=[],
)

set_cluster_settings(*, cluster_id: str, settings: List[ClusterSetting], zone: Optional[str] = None) → ClusterSettingsResponse

Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. :param cluster_id: UUID of the Database Instance where the settings must be set. :param settings: Settings to define for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ClusterSettingsResponse

Usage:

result = api.set_cluster_settings(
    cluster_id="example",
    settings=[],
)

set_endpoints(*, cluster_id: str, endpoints: List[EndpointSpec], zone: Optional[str] = None) → SetEndpointsResponse

Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the cluster_id and the endpoints parameters in your request. :param cluster_id: UUID of the Database Instance where the endpoints have to be set. :param endpoints: Endpoints to define for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: SetEndpointsResponse

Usage:

result = api.set_endpoints(
    cluster_id="example",
    endpoints=[],
)

update_cluster(*, cluster_id: str, zone: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, user_name: Optional[str] = None, password: Optional[str] = None) → Cluster

Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including name, tags, user_name and password. :param cluster_id: UUID of the Database Instance to update. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the Database Instance. :param tags: Database Instance tags. :param user_name: Name of the Database Instance user. :param password: Password of the Database Instance user. :return: Cluster

Usage:

result = api.update_cluster(
    cluster_id="example",
)

update_endpoint(*, endpoint_id: str, zone: Optional[str] = None, private_network: Optional[EndpointSpecPrivateNetworkSpec] = None, public_network: Optional[EndpointSpecPublicNetworkSpec] = None) → Endpoint

Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response. :param endpoint_id: UUID of the endpoint you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :param private_network: Private Network details. One-Of (‘endpoint_type’): at most one of ‘private_network’, ‘public_network’ could be set. :param public_network: Public network details. One-Of (‘endpoint_type’): at most one of ‘private_network’, ‘public_network’ could be set. :return: Endpoint

Usage:

result = api.update_endpoint(
    endpoint_id="example",
)

wait_for_cluster(*, cluster_id: str, zone: Optional[str] = None, options: Optional[WaitForOptions[Cluster, bool]] = None) → Cluster

Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.get_cluster(
    cluster_id="example",
)

scaleway.redis.v1.content module

scaleway.redis.v1.content.CLUSTER_TRANSIENT_STATUSES: List[ClusterStatus] = [<ClusterStatus.PROVISIONING: 'provisioning'>, <ClusterStatus.CONFIGURING: 'configuring'>, <ClusterStatus.DELETING: 'deleting'>, <ClusterStatus.AUTOHEALING: 'autohealing'>, <ClusterStatus.INITIALIZING: 'initializing'>]

Lists transient statutes of the enum ClusterStatus.

scaleway.redis.v1.marshalling module

scaleway.redis.v1.marshalling.marshal_ACLRuleSpec(request: ACLRuleSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_AddAclRulesRequest(request: AddAclRulesRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_AddClusterSettingsRequest(request: AddClusterSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_AddEndpointsRequest(request: AddEndpointsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_ClusterSetting(request: ClusterSetting, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_CreateClusterRequest(request: CreateClusterRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_EndpointSpec(request: EndpointSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_EndpointSpecPrivateNetworkSpec(request: EndpointSpecPrivateNetworkSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_EndpointSpecPrivateNetworkSpecIpamConfig(request: EndpointSpecPrivateNetworkSpecIpamConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_EndpointSpecPublicNetworkSpec(request: EndpointSpecPublicNetworkSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_MigrateClusterRequest(request: MigrateClusterRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_SetAclRulesRequest(request: SetAclRulesRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_SetClusterSettingsRequest(request: SetClusterSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_SetEndpointsRequest(request: SetEndpointsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_UpdateClusterRequest(request: UpdateClusterRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.marshal_UpdateEndpointRequest(request: UpdateEndpointRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.redis.v1.marshalling.unmarshal_ACLRule(data: Any) → ACLRule

scaleway.redis.v1.marshalling.unmarshal_AddAclRulesResponse(data: Any) → AddAclRulesResponse

scaleway.redis.v1.marshalling.unmarshal_AddEndpointsResponse(data: Any) → AddEndpointsResponse

scaleway.redis.v1.marshalling.unmarshal_AvailableClusterSetting(data: Any) → AvailableClusterSetting

scaleway.redis.v1.marshalling.unmarshal_Cluster(data: Any) → Cluster

scaleway.redis.v1.marshalling.unmarshal_ClusterMetricsResponse(data: Any) → ClusterMetricsResponse

scaleway.redis.v1.marshalling.unmarshal_ClusterSetting(data: Any) → ClusterSetting

scaleway.redis.v1.marshalling.unmarshal_ClusterSettingsResponse(data: Any) → ClusterSettingsResponse

scaleway.redis.v1.marshalling.unmarshal_ClusterVersion(data: Any) → ClusterVersion

scaleway.redis.v1.marshalling.unmarshal_Endpoint(data: Any) → Endpoint

scaleway.redis.v1.marshalling.unmarshal_ListClusterVersionsResponse(data: Any) → ListClusterVersionsResponse

scaleway.redis.v1.marshalling.unmarshal_ListClustersResponse(data: Any) → ListClustersResponse

scaleway.redis.v1.marshalling.unmarshal_ListNodeTypesResponse(data: Any) → ListNodeTypesResponse

scaleway.redis.v1.marshalling.unmarshal_NodeType(data: Any) → NodeType

scaleway.redis.v1.marshalling.unmarshal_PrivateNetwork(data: Any) → PrivateNetwork

scaleway.redis.v1.marshalling.unmarshal_PublicNetwork(data: Any) → PublicNetwork

scaleway.redis.v1.marshalling.unmarshal_SetAclRulesResponse(data: Any) → SetAclRulesResponse

scaleway.redis.v1.marshalling.unmarshal_SetEndpointsResponse(data: Any) → SetEndpointsResponse

scaleway.redis.v1.types module

class scaleway.redis.v1.types.ACLRule(id: 'str', ip_cidr: 'Optional[str]', description: 'Optional[str]')

Bases: object

description: Optional[str]

Description of the rule.

id: str

ID of the rule.

ip_cidr: Optional[str]

IPv4 network address of the rule.

class scaleway.redis.v1.types.ACLRuleSpec(ip_cidr: 'str', description: 'str')

Bases: object

description: str

Description of the rule.

ip_cidr: str

IPv4 network address of the rule.

class scaleway.redis.v1.types.AddAclRulesRequest(cluster_id: 'str', acl_rules: 'List[ACLRuleSpec]', zone: 'Optional[ScwZone]')

Bases: object

acl_rules: List[ACLRuleSpec]

ACLs rules to add to the cluster.

cluster_id: str

UUID of the Database Instance you want to add ACL rules to.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.AddAclRulesResponse(acl_rules: 'List[ACLRule]', total_count: 'int')

Bases: object

acl_rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

total_count: int

Total count of ACL rules of the Database Instance.

class scaleway.redis.v1.types.AddClusterSettingsRequest(cluster_id: 'str', settings: 'List[ClusterSetting]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance you want to add settings to.

settings: List[ClusterSetting]

Settings to add to the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.AddEndpointsRequest(cluster_id: 'str', endpoints: 'List[EndpointSpec]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance you want to add endpoints to.

endpoints: List[EndpointSpec]

Endpoints to add to the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.AddEndpointsResponse(endpoints: 'List[Endpoint]', total_count: 'int')

Bases: object

endpoints: List[Endpoint]

Endpoints defined on the Database Instance.

total_count: int

Total count of endpoints of the Database Instance.

class scaleway.redis.v1.types.AvailableClusterSetting(name: 'str', type_: 'AvailableClusterSettingPropertyType', description: 'str', deprecated: 'bool', default_value: 'Optional[str]', max_value: 'Optional[int]', min_value: 'Optional[int]', regex: 'Optional[str]')

Bases: object

default_value: Optional[str]

Default value of the setting.

deprecated: bool

Defines whether or not the setting is deprecated.

description: str

Description of the setting.

max_value: Optional[int]

Optional maximum value of the setting.

min_value: Optional[int]

Optional minimum value of the setting.

name: str

Name of the setting.

regex: Optional[str]

Optional validation rule of the setting.

type_: AvailableClusterSettingPropertyType

Type of setting.

class scaleway.redis.v1.types.AvailableClusterSettingPropertyType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BOOLEAN = 'boolean'

INT = 'int'

STRING = 'string'

UNKNOWN = 'unknown'

class scaleway.redis.v1.types.Cluster(id: 'str', name: 'str', project_id: 'str', status: 'ClusterStatus', version: 'str', endpoints: 'List[Endpoint]', tags: 'List[str]', node_type: 'str', tls_enabled: 'bool', cluster_settings: 'List[ClusterSetting]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', acl_rules: 'List[ACLRule]', cluster_size: 'int', zone: 'ScwZone', user_name: 'str', upgradable_versions: 'List[str]')

Bases: object

acl_rules: List[ACLRule]

List of ACL rules.

cluster_settings: List[ClusterSetting]

List of Database Instance settings.

cluster_size: int

Number of nodes of the Database Instance cluster.

created_at: Optional[datetime]

Creation date (Format ISO 8601).

endpoints: List[Endpoint]

List of Database Instance endpoints.

id: str

UUID of the Database Instance.

name: str

Name of the Database Instance.

node_type: str

Node type of the Database Instance.

project_id: str

Project ID the Database Instance belongs to.

status: ClusterStatus

Status of the Database Instance.

tags: List[str]

List of tags applied to the Database Instance.

tls_enabled: bool

Defines whether or not TLS is enabled.

updated_at: Optional[datetime]

Update date (Format ISO 8601).

upgradable_versions: List[str]

List of engine versions the Database Instance can upgrade to.

user_name: str

Name of the user associated to the cluster.

version: str

Redis™ engine version of the Database Instance.

zone: str

Zone of the Database Instance.

class scaleway.redis.v1.types.ClusterMetricsResponse(timeseries: 'List[TimeSeries]')

Bases: object

timeseries: List[TimeSeries]

Time series of metrics of a given cluster.

class scaleway.redis.v1.types.ClusterSetting(value: 'str', name: 'str')

Bases: object

name: str

Name of the setting.

value: str

Value of the setting.

class scaleway.redis.v1.types.ClusterSettingsResponse(settings: 'List[ClusterSetting]')

Bases: object

settings: List[ClusterSetting]

Settings configured for a given Database Instance.

class scaleway.redis.v1.types.ClusterStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTOHEALING = 'autohealing'

CONFIGURING = 'configuring'

DELETING = 'deleting'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

READY = 'ready'

SUSPENDED = 'suspended'

UNKNOWN = 'unknown'

class scaleway.redis.v1.types.ClusterVersion(version: 'str', available_settings: 'List[AvailableClusterSetting]', logo_url: 'str', zone: 'ScwZone', end_of_life_at: 'Optional[datetime]')

Bases: object

available_settings: List[AvailableClusterSetting]

Cluster settings available to be updated.

end_of_life_at: Optional[datetime]

Date of End of Life.

logo_url: str

Redis™ logo url.

version: str

Redis™ engine version.

zone: str

Zone of the Redis™ Database Instance.

class scaleway.redis.v1.types.CreateClusterRequest(version: 'str', node_type: 'str', zone: 'Optional[ScwZone]', project_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', user_name: 'str', password: 'str', tls_enabled: 'bool', cluster_size: 'Optional[int]', acl_rules: 'Optional[List[ACLRuleSpec]]', endpoints: 'Optional[List[EndpointSpec]]', cluster_settings: 'Optional[List[ClusterSetting]]')

Bases: object

acl_rules: Optional[List[ACLRuleSpec]]

List of ACLRuleSpec used to secure your publicly exposed cluster.

cluster_settings: Optional[List[ClusterSetting]]

List of advanced settings to be set upon Database Instance initialization.

cluster_size: Optional[int]

Number of nodes in the Redis™ cluster.

endpoints: Optional[List[EndpointSpec]]

Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.

name: Optional[str]

Name of the Database Instance.

node_type: str

Type of node to use for the Database Instance.

password: str

Password of the user.

project_id: Optional[str]

Project ID in which to create the Database Instance.

tags: Optional[List[str]]

Tags to apply to the Database Instance.

tls_enabled: bool

Defines whether or not TLS is enabled.

user_name: str

Name of the user created upon Database Instance creation.

version: str

Redis™ engine version of the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.DeleteAclRuleRequest(acl_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

acl_id: str

UUID of the ACL rule you want to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.DeleteClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.DeleteClusterSettingRequest(cluster_id: 'str', setting_name: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the settings must be set.

setting_name: str

Setting name to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.DeleteEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.Endpoint(port: 'int', ips: 'List[str]', id: 'str', private_network: 'Optional[PrivateNetwork]', public_network: 'Optional[PublicNetwork]')

Bases: object

id: str

UUID of the endpoint.

ips: List[str]

List of IPv4 addresses of the endpoint.

port: int

TCP port of the endpoint.

private_network: Optional[PrivateNetwork]

public_network: Optional[PublicNetwork]

class scaleway.redis.v1.types.EndpointSpec(private_network: 'Optional[EndpointSpecPrivateNetworkSpec]', public_network: 'Optional[EndpointSpecPublicNetworkSpec]')

Bases: object

private_network: Optional[EndpointSpecPrivateNetworkSpec]

public_network: Optional[EndpointSpecPublicNetworkSpec]

class scaleway.redis.v1.types.EndpointSpecPrivateNetworkSpec(id: 'str', service_ips: 'List[str]', ipam_config: 'Optional[EndpointSpecPrivateNetworkSpecIpamConfig]')

Bases: object

id: str

UUID of the Private Network to connect to the Database Instance.

ipam_config: Optional[EndpointSpecPrivateNetworkSpecIpamConfig]

Automated configuration of your Private Network endpoint with Scaleway IPAM service.

service_ips: List[str]

Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.

class scaleway.redis.v1.types.EndpointSpecPrivateNetworkSpecIpamConfig

Bases: object

class scaleway.redis.v1.types.EndpointSpecPublicNetworkSpec

Bases: object

class scaleway.redis.v1.types.GetAclRuleRequest(acl_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

acl_id: str

UUID of the ACL rule you want to get.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.GetClusterCertificateRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.GetClusterMetricsRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', start_at: 'Optional[datetime]', end_at: 'Optional[datetime]', metric_name: 'Optional[str]')

Bases: object

cluster_id: str

UUID of the cluster.

end_at: Optional[datetime]

End date.

metric_name: Optional[str]

Name of the metric to gather.

start_at: Optional[datetime]

Start date.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.GetClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.GetEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.ListClusterVersionsRequest(include_disabled: 'bool', include_beta: 'bool', include_deprecated: 'bool', zone: 'Optional[ScwZone]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_beta: bool

Defines whether or not to include beta Redis™ engine versions.

include_deprecated: bool

Defines whether or not to include deprecated Redis™ engine versions.

include_disabled: bool

Defines whether or not to include disabled Redis™ engine versions.

page: Optional[int]

page_size: Optional[int]

version: Optional[str]

List Redis™ engine versions that match a given name pattern.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.ListClusterVersionsResponse(versions: 'List[ClusterVersion]', total_count: 'int')

Bases: object

total_count: int

Total count of available Redis™ engine versions.

versions: List[ClusterVersion]

List of available Redis™ engine versions.

class scaleway.redis.v1.types.ListClustersRequest(zone: 'Optional[ScwZone]', tags: 'Optional[List[str]]', name: 'Optional[str]', order_by: 'Optional[ListClustersRequestOrderBy]', project_id: 'Optional[str]', organization_id: 'Optional[str]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Filter by Database Instance names.

order_by: Optional[ListClustersRequestOrderBy]

Criteria to use when ordering the list.

organization_id: Optional[str]

Filter by Organization ID.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Filter by Project ID.

tags: Optional[List[str]]

Filter by Database Instance tags.

version: Optional[str]

Filter by Redis™ engine version.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.ListClustersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.redis.v1.types.ListClustersResponse(clusters: 'List[Cluster]', total_count: 'int')

Bases: object

clusters: List[Cluster]

List all Database Instances.

total_count: int

Total count of Database Instances.

class scaleway.redis.v1.types.ListNodeTypesRequest(include_disabled_types: 'bool', zone: 'Optional[ScwZone]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_disabled_types: bool

Defines whether or not to include disabled types.

page: Optional[int]

page_size: Optional[int]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.ListNodeTypesResponse(node_types: 'List[NodeType]', total_count: 'int')

Bases: object

node_types: List[NodeType]

Types of node.

total_count: int

Total count of node types available.

class scaleway.redis.v1.types.MigrateClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', version: 'Optional[str]', node_type: 'Optional[str]', cluster_size: 'Optional[int]')

Bases: object

cluster_id: str

UUID of the Database Instance to update.

cluster_size: Optional[int]

node_type: Optional[str]

version: Optional[str]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.NodeType(name: 'str', stock_status: 'NodeTypeStock', description: 'str', vcpus: 'int', memory: 'int', disabled: 'bool', beta: 'bool', zone: 'ScwZone')

Bases: object

beta: bool

Defines whether node type is currently in beta.

description: str

Current specifications of the offer.

disabled: bool

Defines whether node type is currently disabled or not.

memory: int

Quantity of RAM.

name: str

Node type name.

stock_status: NodeTypeStock

Current stock status of the node type.

vcpus: int

Number of virtual CPUs.

zone: str

Zone of the node type.

class scaleway.redis.v1.types.NodeTypeStock(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

LOW_STOCK = 'low_stock'

OUT_OF_STOCK = 'out_of_stock'

UNKNOWN = 'unknown'

class scaleway.redis.v1.types.PrivateNetwork(id: 'str', service_ips: 'List[str]', zone: 'ScwZone', provisioning_mode: 'PrivateNetworkProvisioningMode')

Bases: object

id: str

UUID of the Private Network.

provisioning_mode: PrivateNetworkProvisioningMode

How your endpoint ips are provisioned.

service_ips: List[str]

List of IPv4 CIDR notation addresses of the endpoint.

zone: str

Zone of the Private Network.

class scaleway.redis.v1.types.PrivateNetworkProvisioningMode(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

IPAM = 'ipam'

STATIC = 'static'

class scaleway.redis.v1.types.PublicNetwork

Bases: object

class scaleway.redis.v1.types.RenewClusterCertificateRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.SetAclRulesRequest(cluster_id: 'str', acl_rules: 'List[ACLRuleSpec]', zone: 'Optional[ScwZone]')

Bases: object

acl_rules: List[ACLRuleSpec]

ACLs rules to define for the cluster.

cluster_id: str

UUID of the Database Instance where the ACL rules have to be set.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.SetAclRulesResponse(acl_rules: 'List[ACLRule]')

Bases: object

acl_rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

class scaleway.redis.v1.types.SetClusterSettingsRequest(cluster_id: 'str', settings: 'List[ClusterSetting]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the settings must be set.

settings: List[ClusterSetting]

Settings to define for the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.SetEndpointsRequest(cluster_id: 'str', endpoints: 'List[EndpointSpec]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the endpoints have to be set.

endpoints: List[EndpointSpec]

Endpoints to define for the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.SetEndpointsResponse(endpoints: 'List[Endpoint]')

Bases: object

endpoints: List[Endpoint]

Endpoints defined on the Database Instance.

class scaleway.redis.v1.types.UpdateClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', name: 'Optional[str]', tags: 'Optional[List[str]]', user_name: 'Optional[str]', password: 'Optional[str]')

Bases: object

cluster_id: str

UUID of the Database Instance to update.

name: Optional[str]

Name of the Database Instance.

password: Optional[str]

Password of the Database Instance user.

tags: Optional[List[str]]

Database Instance tags.

user_name: Optional[str]

Name of the Database Instance user.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.types.UpdateEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]', private_network: 'Optional[EndpointSpecPrivateNetworkSpec]', public_network: 'Optional[EndpointSpecPublicNetworkSpec]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

private_network: Optional[EndpointSpecPrivateNetworkSpec]

public_network: Optional[EndpointSpecPublicNetworkSpec]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

Module contents

class scaleway.redis.v1.ACLRule(id: 'str', ip_cidr: 'Optional[str]', description: 'Optional[str]')

Bases: object

description: Optional[str]

Description of the rule.

id: str

ID of the rule.

ip_cidr: Optional[str]

IPv4 network address of the rule.

class scaleway.redis.v1.ACLRuleSpec(ip_cidr: 'str', description: 'str')

Bases: object

description: str

Description of the rule.

ip_cidr: str

IPv4 network address of the rule.

class scaleway.redis.v1.AddAclRulesRequest(cluster_id: 'str', acl_rules: 'List[ACLRuleSpec]', zone: 'Optional[ScwZone]')

Bases: object

acl_rules: List[ACLRuleSpec]

ACLs rules to add to the cluster.

cluster_id: str

UUID of the Database Instance you want to add ACL rules to.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.AddAclRulesResponse(acl_rules: 'List[ACLRule]', total_count: 'int')

Bases: object

acl_rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

total_count: int

Total count of ACL rules of the Database Instance.

class scaleway.redis.v1.AddClusterSettingsRequest(cluster_id: 'str', settings: 'List[ClusterSetting]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance you want to add settings to.

settings: List[ClusterSetting]

Settings to add to the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.AddEndpointsRequest(cluster_id: 'str', endpoints: 'List[EndpointSpec]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance you want to add endpoints to.

endpoints: List[EndpointSpec]

Endpoints to add to the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.AddEndpointsResponse(endpoints: 'List[Endpoint]', total_count: 'int')

Bases: object

endpoints: List[Endpoint]

Endpoints defined on the Database Instance.

total_count: int

Total count of endpoints of the Database Instance.

class scaleway.redis.v1.AvailableClusterSetting(name: 'str', type_: 'AvailableClusterSettingPropertyType', description: 'str', deprecated: 'bool', default_value: 'Optional[str]', max_value: 'Optional[int]', min_value: 'Optional[int]', regex: 'Optional[str]')

Bases: object

default_value: Optional[str]

Default value of the setting.

deprecated: bool

Defines whether or not the setting is deprecated.

description: str

Description of the setting.

max_value: Optional[int]

Optional maximum value of the setting.

min_value: Optional[int]

Optional minimum value of the setting.

name: str

Name of the setting.

regex: Optional[str]

Optional validation rule of the setting.

type_: AvailableClusterSettingPropertyType

Type of setting.

class scaleway.redis.v1.AvailableClusterSettingPropertyType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BOOLEAN = 'boolean'

INT = 'int'

STRING = 'string'

UNKNOWN = 'unknown'

class scaleway.redis.v1.Cluster(id: 'str', name: 'str', project_id: 'str', status: 'ClusterStatus', version: 'str', endpoints: 'List[Endpoint]', tags: 'List[str]', node_type: 'str', tls_enabled: 'bool', cluster_settings: 'List[ClusterSetting]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', acl_rules: 'List[ACLRule]', cluster_size: 'int', zone: 'ScwZone', user_name: 'str', upgradable_versions: 'List[str]')

Bases: object

acl_rules: List[ACLRule]

List of ACL rules.

cluster_settings: List[ClusterSetting]

List of Database Instance settings.

cluster_size: int

Number of nodes of the Database Instance cluster.

created_at: Optional[datetime]

Creation date (Format ISO 8601).

endpoints: List[Endpoint]

List of Database Instance endpoints.

id: str

UUID of the Database Instance.

name: str

Name of the Database Instance.

node_type: str

Node type of the Database Instance.

project_id: str

Project ID the Database Instance belongs to.

status: ClusterStatus

Status of the Database Instance.

tags: List[str]

List of tags applied to the Database Instance.

tls_enabled: bool

Defines whether or not TLS is enabled.

updated_at: Optional[datetime]

Update date (Format ISO 8601).

upgradable_versions: List[str]

List of engine versions the Database Instance can upgrade to.

user_name: str

Name of the user associated to the cluster.

version: str

Redis™ engine version of the Database Instance.

zone: str

Zone of the Database Instance.

class scaleway.redis.v1.ClusterMetricsResponse(timeseries: 'List[TimeSeries]')

Bases: object

timeseries: List[TimeSeries]

Time series of metrics of a given cluster.

class scaleway.redis.v1.ClusterSetting(value: 'str', name: 'str')

Bases: object

name: str

Name of the setting.

value: str

Value of the setting.

class scaleway.redis.v1.ClusterSettingsResponse(settings: 'List[ClusterSetting]')

Bases: object

settings: List[ClusterSetting]

Settings configured for a given Database Instance.

class scaleway.redis.v1.ClusterStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTOHEALING = 'autohealing'

CONFIGURING = 'configuring'

DELETING = 'deleting'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

READY = 'ready'

SUSPENDED = 'suspended'

UNKNOWN = 'unknown'

class scaleway.redis.v1.ClusterVersion(version: 'str', available_settings: 'List[AvailableClusterSetting]', logo_url: 'str', zone: 'ScwZone', end_of_life_at: 'Optional[datetime]')

Bases: object

available_settings: List[AvailableClusterSetting]

Cluster settings available to be updated.

end_of_life_at: Optional[datetime]

Date of End of Life.

logo_url: str

Redis™ logo url.

version: str

Redis™ engine version.

zone: str

Zone of the Redis™ Database Instance.

class scaleway.redis.v1.CreateClusterRequest(version: 'str', node_type: 'str', zone: 'Optional[ScwZone]', project_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', user_name: 'str', password: 'str', tls_enabled: 'bool', cluster_size: 'Optional[int]', acl_rules: 'Optional[List[ACLRuleSpec]]', endpoints: 'Optional[List[EndpointSpec]]', cluster_settings: 'Optional[List[ClusterSetting]]')

Bases: object

acl_rules: Optional[List[ACLRuleSpec]]

List of ACLRuleSpec used to secure your publicly exposed cluster.

cluster_settings: Optional[List[ClusterSetting]]

List of advanced settings to be set upon Database Instance initialization.

cluster_size: Optional[int]

Number of nodes in the Redis™ cluster.

endpoints: Optional[List[EndpointSpec]]

Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.

name: Optional[str]

Name of the Database Instance.

node_type: str

Type of node to use for the Database Instance.

password: str

Password of the user.

project_id: Optional[str]

Project ID in which to create the Database Instance.

tags: Optional[List[str]]

Tags to apply to the Database Instance.

tls_enabled: bool

Defines whether or not TLS is enabled.

user_name: str

Name of the user created upon Database Instance creation.

version: str

Redis™ engine version of the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.DeleteAclRuleRequest(acl_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

acl_id: str

UUID of the ACL rule you want to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.DeleteClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.DeleteClusterSettingRequest(cluster_id: 'str', setting_name: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the settings must be set.

setting_name: str

Setting name to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.DeleteEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to delete.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.Endpoint(port: 'int', ips: 'List[str]', id: 'str', private_network: 'Optional[PrivateNetwork]', public_network: 'Optional[PublicNetwork]')

Bases: object

id: str

UUID of the endpoint.

ips: List[str]

List of IPv4 addresses of the endpoint.

port: int

TCP port of the endpoint.

private_network: Optional[PrivateNetwork]

public_network: Optional[PublicNetwork]

class scaleway.redis.v1.EndpointSpec(private_network: 'Optional[EndpointSpecPrivateNetworkSpec]', public_network: 'Optional[EndpointSpecPublicNetworkSpec]')

Bases: object

private_network: Optional[EndpointSpecPrivateNetworkSpec]

public_network: Optional[EndpointSpecPublicNetworkSpec]

class scaleway.redis.v1.EndpointSpecPrivateNetworkSpec(id: 'str', service_ips: 'List[str]', ipam_config: 'Optional[EndpointSpecPrivateNetworkSpecIpamConfig]')

Bases: object

id: str

UUID of the Private Network to connect to the Database Instance.

ipam_config: Optional[EndpointSpecPrivateNetworkSpecIpamConfig]

Automated configuration of your Private Network endpoint with Scaleway IPAM service.

service_ips: List[str]

Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.

class scaleway.redis.v1.EndpointSpecPrivateNetworkSpecIpamConfig

Bases: object

class scaleway.redis.v1.EndpointSpecPublicNetworkSpec

Bases: object

class scaleway.redis.v1.GetAclRuleRequest(acl_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

acl_id: str

UUID of the ACL rule you want to get.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.GetClusterCertificateRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.GetClusterMetricsRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', start_at: 'Optional[datetime]', end_at: 'Optional[datetime]', metric_name: 'Optional[str]')

Bases: object

cluster_id: str

UUID of the cluster.

end_at: Optional[datetime]

End date.

metric_name: Optional[str]

Name of the metric to gather.

start_at: Optional[datetime]

Start date.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.GetClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.GetEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.ListClusterVersionsRequest(include_disabled: 'bool', include_beta: 'bool', include_deprecated: 'bool', zone: 'Optional[ScwZone]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_beta: bool

Defines whether or not to include beta Redis™ engine versions.

include_deprecated: bool

Defines whether or not to include deprecated Redis™ engine versions.

include_disabled: bool

Defines whether or not to include disabled Redis™ engine versions.

page: Optional[int]

page_size: Optional[int]

version: Optional[str]

List Redis™ engine versions that match a given name pattern.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.ListClusterVersionsResponse(versions: 'List[ClusterVersion]', total_count: 'int')

Bases: object

total_count: int

Total count of available Redis™ engine versions.

versions: List[ClusterVersion]

List of available Redis™ engine versions.

class scaleway.redis.v1.ListClustersRequest(zone: 'Optional[ScwZone]', tags: 'Optional[List[str]]', name: 'Optional[str]', order_by: 'Optional[ListClustersRequestOrderBy]', project_id: 'Optional[str]', organization_id: 'Optional[str]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Filter by Database Instance names.

order_by: Optional[ListClustersRequestOrderBy]

Criteria to use when ordering the list.

organization_id: Optional[str]

Filter by Organization ID.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Filter by Project ID.

tags: Optional[List[str]]

Filter by Database Instance tags.

version: Optional[str]

Filter by Redis™ engine version.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.ListClustersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.redis.v1.ListClustersResponse(clusters: 'List[Cluster]', total_count: 'int')

Bases: object

clusters: List[Cluster]

List all Database Instances.

total_count: int

Total count of Database Instances.

class scaleway.redis.v1.ListNodeTypesRequest(include_disabled_types: 'bool', zone: 'Optional[ScwZone]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_disabled_types: bool

Defines whether or not to include disabled types.

page: Optional[int]

page_size: Optional[int]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.ListNodeTypesResponse(node_types: 'List[NodeType]', total_count: 'int')

Bases: object

node_types: List[NodeType]

Types of node.

total_count: int

Total count of node types available.

class scaleway.redis.v1.MigrateClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', version: 'Optional[str]', node_type: 'Optional[str]', cluster_size: 'Optional[int]')

Bases: object

cluster_id: str

UUID of the Database Instance to update.

cluster_size: Optional[int]

node_type: Optional[str]

version: Optional[str]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.NodeType(name: 'str', stock_status: 'NodeTypeStock', description: 'str', vcpus: 'int', memory: 'int', disabled: 'bool', beta: 'bool', zone: 'ScwZone')

Bases: object

beta: bool

Defines whether node type is currently in beta.

description: str

Current specifications of the offer.

disabled: bool

Defines whether node type is currently disabled or not.

memory: int

Quantity of RAM.

name: str

Node type name.

stock_status: NodeTypeStock

Current stock status of the node type.

vcpus: int

Number of virtual CPUs.

zone: str

Zone of the node type.

class scaleway.redis.v1.NodeTypeStock(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

LOW_STOCK = 'low_stock'

OUT_OF_STOCK = 'out_of_stock'

UNKNOWN = 'unknown'

class scaleway.redis.v1.PrivateNetwork(id: 'str', service_ips: 'List[str]', zone: 'ScwZone', provisioning_mode: 'PrivateNetworkProvisioningMode')

Bases: object

id: str

UUID of the Private Network.

provisioning_mode: PrivateNetworkProvisioningMode

How your endpoint ips are provisioned.

service_ips: List[str]

List of IPv4 CIDR notation addresses of the endpoint.

zone: str

Zone of the Private Network.

class scaleway.redis.v1.PrivateNetworkProvisioningMode(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

IPAM = 'ipam'

STATIC = 'static'

class scaleway.redis.v1.PublicNetwork

Bases: object

class scaleway.redis.v1.RedisV1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Managed Databases for Redis™.

add_acl_rules(*, cluster_id: str, acl_rules: List[ACLRuleSpec], zone: Optional[str] = None) → AddAclRulesResponse

Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster). :param cluster_id: UUID of the Database Instance you want to add ACL rules to. :param acl_rules: ACLs rules to add to the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: AddAclRulesResponse

Usage:

result = api.add_acl_rules(
    cluster_id="example",
    acl_rules=[],
)

add_cluster_settings(*, cluster_id: str, settings: List[ClusterSetting], zone: Optional[str] = None) → ClusterSettingsResponse

Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the name and the value of each setting. :param cluster_id: UUID of the Database Instance you want to add settings to. :param settings: Settings to add to the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ClusterSettingsResponse

Usage:

result = api.add_cluster_settings(
    cluster_id="example",
    settings=[],
)

add_endpoints(*, cluster_id: str, endpoints: List[EndpointSpec], zone: Optional[str] = None) → AddEndpointsResponse

Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add private_network or public_network specifications to the body of the request. :param cluster_id: UUID of the Database Instance you want to add endpoints to. :param endpoints: Endpoints to add to the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: AddEndpointsResponse

Usage:

result = api.add_endpoints(
    cluster_id="example",
    endpoints=[],
)

create_cluster(*, version: str, node_type: str, zone: Optional[str] = None, project_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, user_name: str, password: str, tls_enabled: bool, cluster_size: Optional[int] = None, acl_rules: Optional[List[ACLRuleSpec]] = None, endpoints: Optional[List[EndpointSpec]] = None, cluster_settings: Optional[List[ClusterSetting]] = None) → Cluster

Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the zone, project_id, version, node_type, user_name and password parameters. Optionally you can define acl_rules, endpoints, tls_enabled and cluster_settings. :param version: Redis™ engine version of the Database Instance. :param node_type: Type of node to use for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :param project_id: Project ID in which to create the Database Instance. :param name: Name of the Database Instance. :param tags: Tags to apply to the Database Instance. :param user_name: Name of the user created upon Database Instance creation. :param password: Password of the user. :param tls_enabled: Defines whether or not TLS is enabled. :param cluster_size: Number of nodes in the Redis™ cluster. :param acl_rules: List of ACLRuleSpec used to secure your publicly exposed cluster. :param endpoints: Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default. :param cluster_settings: List of advanced settings to be set upon Database Instance initialization. :return: Cluster

Usage:

result = api.create_cluster(
    version="example",
    node_type="example",
    user_name="example",
    password="example",
    tls_enabled=False,
)

delete_acl_rule(*, acl_id: str, zone: Optional[str] = None) → Cluster

Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule you want to delete in your request. :param acl_id: UUID of the ACL rule you want to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_acl_rule(
    acl_id="example",
)

delete_cluster(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the region and cluster_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. :param cluster_id: UUID of the Database Instance to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_cluster(
    cluster_id="example",
)

delete_cluster_setting(*, cluster_id: str, setting_name: str, zone: Optional[str] = None) → Cluster

Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body. :param cluster_id: UUID of the Database Instance where the settings must be set. :param setting_name: Setting name to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_cluster_setting(
    cluster_id="example",
    setting_name="example",
)

delete_endpoint(*, endpoint_id: str, zone: Optional[str] = None) → Cluster

Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the region and endpoint_id parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. :param endpoint_id: UUID of the endpoint you want to delete. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.delete_endpoint(
    endpoint_id="example",
)

get_acl_rule(*, acl_id: str, zone: Optional[str] = None) → ACLRule

Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule in your request. :param acl_id: UUID of the ACL rule you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ACLRule

Usage:

result = api.get_acl_rule(
    acl_id="example",
)

get_cluster(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.get_cluster(
    cluster_id="example",
)

get_cluster_certificate(*, cluster_id: str, zone: Optional[str] = None) → ScwFile

Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ScwFile

Usage:

result = api.get_cluster_certificate(
    cluster_id="example",
)

get_cluster_metrics(*, cluster_id: str, zone: Optional[str] = None, start_at: Optional[datetime] = None, end_at: Optional[datetime] = None, metric_name: Optional[str] = None) → ClusterMetricsResponse

Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the start_date and end_date. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :param start_at: Start date. :param end_at: End date. :param metric_name: Name of the metric to gather. :return: ClusterMetricsResponse

Usage:

result = api.get_cluster_metrics(
    cluster_id="example",
)

get_endpoint(*, endpoint_id: str, zone: Optional[str] = None) → Endpoint

Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response. :param endpoint_id: UUID of the endpoint you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Endpoint

Usage:

result = api.get_endpoint(
    endpoint_id="example",
)

list_cluster_versions(*, include_disabled: bool, include_beta: bool, include_deprecated: bool, zone: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListClusterVersionsResponse

List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as include_disabled, include_beta, include_deprecated and version. :param include_disabled: Defines whether or not to include disabled Redis™ engine versions. :param include_beta: Defines whether or not to include beta Redis™ engine versions. :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: List Redis™ engine versions that match a given name pattern. :param page: :param page_size: :return: ListClusterVersionsResponse

Usage:

result = api.list_cluster_versions(
    include_disabled=False,
    include_beta=False,
    include_deprecated=False,
)

list_cluster_versions_all(*, include_disabled: bool, include_beta: bool, include_deprecated: bool, zone: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[ClusterVersion]

List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as include_disabled, include_beta, include_deprecated and version. :param include_disabled: Defines whether or not to include disabled Redis™ engine versions. :param include_beta: Defines whether or not to include beta Redis™ engine versions. :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: List Redis™ engine versions that match a given name pattern. :param page: :param page_size: :return: List[ClusterVersion]

Usage:

result = api.list_cluster_versions_all(
    include_disabled=False,
    include_beta=False,
    include_deprecated=False,
)

list_clusters(*, zone: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListClustersRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListClustersResponse

List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags, name, organization_id and version. :param zone: Zone to target. If none is passed will use default zone from the config. :param tags: Filter by Database Instance tags. :param name: Filter by Database Instance names. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by Project ID. :param organization_id: Filter by Organization ID. :param version: Filter by Redis™ engine version. :param page: :param page_size: :return: ListClustersResponse

Usage:

result = api.list_clusters()

list_clusters_all(*, zone: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListClustersRequestOrderBy] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Cluster]

List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags, name, organization_id and version. :param zone: Zone to target. If none is passed will use default zone from the config. :param tags: Filter by Database Instance tags. :param name: Filter by Database Instance names. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by Project ID. :param organization_id: Filter by Organization ID. :param version: Filter by Redis™ engine version. :param page: :param page_size: :return: List[Cluster]

Usage:

result = api.list_clusters_all()

list_node_types(*, include_disabled_types: bool, zone: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNodeTypesResponse

List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param include_disabled_types: Defines whether or not to include disabled types. :param zone: Zone to target. If none is passed will use default zone from the config. :param page: :param page_size: :return: ListNodeTypesResponse

Usage:

result = api.list_node_types(
    include_disabled_types=False,
)

list_node_types_all(*, include_disabled_types: bool, zone: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[NodeType]

List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. :param include_disabled_types: Defines whether or not to include disabled types. :param zone: Zone to target. If none is passed will use default zone from the config. :param page: :param page_size: :return: List[NodeType]

Usage:

result = api.list_node_types_all(
    include_disabled_types=False,
)

migrate_cluster(*, cluster_id: str, zone: Optional[str] = None, version: Optional[str] = None, node_type: Optional[str] = None, cluster_size: Optional[int] = None) → Cluster

Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint. :param cluster_id: UUID of the Database Instance to update. :param zone: Zone to target. If none is passed will use default zone from the config. :param version: Redis™ engine version of the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :param node_type: Type of node to use for the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :param cluster_size: Number of nodes for the Database Instance. One-Of (‘action’): at most one of ‘version’, ‘node_type’, ‘cluster_size’ could be set. :return: Cluster

Usage:

result = api.migrate_cluster(
    cluster_id="example",
)

renew_cluster_certificate(*, cluster_id: str, zone: Optional[str] = None) → Cluster

Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.renew_cluster_certificate(
    cluster_id="example",
)

set_acl_rules(*, cluster_id: str, acl_rules: List[ACLRuleSpec], zone: Optional[str] = None) → SetAclRulesResponse

Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster). :param cluster_id: UUID of the Database Instance where the ACL rules have to be set. :param acl_rules: ACLs rules to define for the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: SetAclRulesResponse

Usage:

result = api.set_acl_rules(
    cluster_id="example",
    acl_rules=[],
)

set_cluster_settings(*, cluster_id: str, settings: List[ClusterSetting], zone: Optional[str] = None) → ClusterSettingsResponse

Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. :param cluster_id: UUID of the Database Instance where the settings must be set. :param settings: Settings to define for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: ClusterSettingsResponse

Usage:

result = api.set_cluster_settings(
    cluster_id="example",
    settings=[],
)

set_endpoints(*, cluster_id: str, endpoints: List[EndpointSpec], zone: Optional[str] = None) → SetEndpointsResponse

Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the cluster_id and the endpoints parameters in your request. :param cluster_id: UUID of the Database Instance where the endpoints have to be set. :param endpoints: Endpoints to define for the Database Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :return: SetEndpointsResponse

Usage:

result = api.set_endpoints(
    cluster_id="example",
    endpoints=[],
)

update_cluster(*, cluster_id: str, zone: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, user_name: Optional[str] = None, password: Optional[str] = None) → Cluster

Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including name, tags, user_name and password. :param cluster_id: UUID of the Database Instance to update. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the Database Instance. :param tags: Database Instance tags. :param user_name: Name of the Database Instance user. :param password: Password of the Database Instance user. :return: Cluster

Usage:

result = api.update_cluster(
    cluster_id="example",
)

update_endpoint(*, endpoint_id: str, zone: Optional[str] = None, private_network: Optional[EndpointSpecPrivateNetworkSpec] = None, public_network: Optional[EndpointSpecPublicNetworkSpec] = None) → Endpoint

Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response. :param endpoint_id: UUID of the endpoint you want to get. :param zone: Zone to target. If none is passed will use default zone from the config. :param private_network: Private Network details. One-Of (‘endpoint_type’): at most one of ‘private_network’, ‘public_network’ could be set. :param public_network: Public network details. One-Of (‘endpoint_type’): at most one of ‘private_network’, ‘public_network’ could be set. :return: Endpoint

Usage:

result = api.update_endpoint(
    endpoint_id="example",
)

wait_for_cluster(*, cluster_id: str, zone: Optional[str] = None, options: Optional[WaitForOptions[Cluster, bool]] = None) → Cluster

Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response. :param cluster_id: UUID of the cluster. :param zone: Zone to target. If none is passed will use default zone from the config. :return: Cluster

Usage:

result = api.get_cluster(
    cluster_id="example",
)

class scaleway.redis.v1.RenewClusterCertificateRequest(cluster_id: 'str', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the cluster.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.SetAclRulesRequest(cluster_id: 'str', acl_rules: 'List[ACLRuleSpec]', zone: 'Optional[ScwZone]')

Bases: object

acl_rules: List[ACLRuleSpec]

ACLs rules to define for the cluster.

cluster_id: str

UUID of the Database Instance where the ACL rules have to be set.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.SetAclRulesResponse(acl_rules: 'List[ACLRule]')

Bases: object

acl_rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

class scaleway.redis.v1.SetClusterSettingsRequest(cluster_id: 'str', settings: 'List[ClusterSetting]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the settings must be set.

settings: List[ClusterSetting]

Settings to define for the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.SetEndpointsRequest(cluster_id: 'str', endpoints: 'List[EndpointSpec]', zone: 'Optional[ScwZone]')

Bases: object

cluster_id: str

UUID of the Database Instance where the endpoints have to be set.

endpoints: List[EndpointSpec]

Endpoints to define for the Database Instance.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.SetEndpointsResponse(endpoints: 'List[Endpoint]')

Bases: object

endpoints: List[Endpoint]

Endpoints defined on the Database Instance.

class scaleway.redis.v1.UpdateClusterRequest(cluster_id: 'str', zone: 'Optional[ScwZone]', name: 'Optional[str]', tags: 'Optional[List[str]]', user_name: 'Optional[str]', password: 'Optional[str]')

Bases: object

cluster_id: str

UUID of the Database Instance to update.

name: Optional[str]

Name of the Database Instance.

password: Optional[str]

Password of the Database Instance user.

tags: Optional[List[str]]

Database Instance tags.

user_name: Optional[str]

Name of the Database Instance user.

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.

class scaleway.redis.v1.UpdateEndpointRequest(endpoint_id: 'str', zone: 'Optional[ScwZone]', private_network: 'Optional[EndpointSpecPrivateNetworkSpec]', public_network: 'Optional[EndpointSpecPublicNetworkSpec]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

private_network: Optional[EndpointSpecPrivateNetworkSpec]

public_network: Optional[EndpointSpecPublicNetworkSpec]

zone: Optional[str]

Zone to target. If none is passed will use default zone from the config.