pulumi-databricks 1.74.0a1753335781__py3-none-any.whl → 1.77.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_databricks/__init__.py +185 -12
- pulumi_databricks/_inputs.py +30467 -20225
- pulumi_databricks/access_control_rule_set.py +28 -29
- pulumi_databricks/account_federation_policy.py +473 -0
- pulumi_databricks/account_network_policy.py +74 -43
- pulumi_databricks/account_setting_v2.py +759 -0
- pulumi_databricks/aibi_dashboard_embedding_access_policy_setting.py +30 -31
- pulumi_databricks/aibi_dashboard_embedding_approved_domains_setting.py +30 -31
- pulumi_databricks/alert.py +185 -186
- pulumi_databricks/alert_v2.py +369 -211
- pulumi_databricks/app.py +315 -209
- pulumi_databricks/apps_settings_custom_template.py +531 -0
- pulumi_databricks/artifact_allowlist.py +72 -73
- pulumi_databricks/automatic_cluster_update_workspace_setting.py +30 -31
- pulumi_databricks/budget.py +84 -85
- pulumi_databricks/budget_policy.py +75 -53
- pulumi_databricks/catalog.py +544 -225
- pulumi_databricks/catalog_workspace_binding.py +82 -83
- pulumi_databricks/cluster.py +561 -683
- pulumi_databricks/cluster_policy.py +115 -116
- pulumi_databricks/compliance_security_profile_workspace_setting.py +30 -31
- pulumi_databricks/config/__init__.py +1 -1
- pulumi_databricks/config/__init__.pyi +3 -2
- pulumi_databricks/config/vars.py +40 -37
- pulumi_databricks/connection.py +346 -211
- pulumi_databricks/credential.py +262 -263
- pulumi_databricks/custom_app_integration.py +175 -176
- pulumi_databricks/dashboard.py +207 -208
- pulumi_databricks/data_quality_monitor.py +453 -0
- pulumi_databricks/data_quality_refresh.py +492 -0
- pulumi_databricks/database_database_catalog.py +437 -0
- pulumi_databricks/database_instance.py +938 -137
- pulumi_databricks/database_synced_database_table.py +589 -0
- pulumi_databricks/dbfs_file.py +87 -84
- pulumi_databricks/default_namespace_setting.py +30 -31
- pulumi_databricks/directory.py +61 -62
- pulumi_databricks/disable_legacy_access_setting.py +109 -33
- pulumi_databricks/disable_legacy_dbfs_setting.py +58 -39
- pulumi_databricks/disable_legacy_features_setting.py +62 -37
- pulumi_databricks/enhanced_security_monitoring_workspace_setting.py +30 -31
- pulumi_databricks/entitlements.py +148 -149
- pulumi_databricks/entity_tag_assignment.py +409 -0
- pulumi_databricks/external_location.py +276 -290
- pulumi_databricks/external_metadata.py +726 -0
- pulumi_databricks/feature_engineering_feature.py +480 -0
- pulumi_databricks/feature_engineering_materialized_feature.py +397 -0
- pulumi_databricks/file.py +96 -97
- pulumi_databricks/get_account_federation_policies.py +127 -0
- pulumi_databricks/get_account_federation_policy.py +214 -0
- pulumi_databricks/get_account_network_policies.py +36 -7
- pulumi_databricks/get_account_network_policy.py +33 -29
- pulumi_databricks/get_account_setting_v2.py +331 -0
- pulumi_databricks/get_alert_v2.py +100 -84
- pulumi_databricks/get_alerts_v2.py +35 -17
- pulumi_databricks/get_app.py +31 -20
- pulumi_databricks/get_apps.py +26 -15
- pulumi_databricks/get_apps_settings_custom_template.py +207 -0
- pulumi_databricks/get_apps_settings_custom_templates.py +133 -0
- pulumi_databricks/get_aws_assume_role_policy.py +27 -28
- pulumi_databricks/get_aws_bucket_policy.py +39 -40
- pulumi_databricks/get_aws_cross_account_policy.py +47 -48
- pulumi_databricks/get_aws_unity_catalog_assume_role_policy.py +35 -36
- pulumi_databricks/get_aws_unity_catalog_policy.py +35 -36
- pulumi_databricks/get_budget_policies.py +74 -11
- pulumi_databricks/get_budget_policy.py +43 -39
- pulumi_databricks/get_catalog.py +35 -19
- pulumi_databricks/get_catalogs.py +32 -14
- pulumi_databricks/get_cluster.py +41 -25
- pulumi_databricks/get_cluster_policy.py +72 -54
- pulumi_databricks/get_clusters.py +41 -25
- pulumi_databricks/get_current_config.py +23 -24
- pulumi_databricks/get_current_metastore.py +29 -13
- pulumi_databricks/get_current_user.py +17 -18
- pulumi_databricks/get_dashboards.py +34 -15
- pulumi_databricks/get_data_quality_monitor.py +210 -0
- pulumi_databricks/get_data_quality_monitors.py +143 -0
- pulumi_databricks/get_data_quality_refresh.py +270 -0
- pulumi_databricks/get_data_quality_refreshes.py +207 -0
- pulumi_databricks/get_database_database_catalog.py +176 -0
- pulumi_databricks/get_database_database_catalogs.py +120 -0
- pulumi_databricks/get_database_instance.py +274 -50
- pulumi_databricks/get_database_instances.py +35 -11
- pulumi_databricks/get_database_synced_database_table.py +225 -0
- pulumi_databricks/get_database_synced_database_tables.py +120 -0
- pulumi_databricks/get_dbfs_file.py +19 -20
- pulumi_databricks/get_dbfs_file_paths.py +16 -17
- pulumi_databricks/get_directory.py +43 -25
- pulumi_databricks/get_entity_tag_assignment.py +202 -0
- pulumi_databricks/get_entity_tag_assignments.py +187 -0
- pulumi_databricks/get_external_location.py +35 -19
- pulumi_databricks/get_external_locations.py +32 -14
- pulumi_databricks/get_external_metadata.py +292 -0
- pulumi_databricks/get_external_metadatas.py +135 -0
- pulumi_databricks/get_feature_engineering_feature.py +179 -0
- pulumi_databricks/get_feature_engineering_features.py +103 -0
- pulumi_databricks/get_feature_engineering_materialized_feature.py +180 -0
- pulumi_databricks/get_feature_engineering_materialized_features.py +123 -0
- pulumi_databricks/get_functions.py +38 -24
- pulumi_databricks/get_group.py +85 -86
- pulumi_databricks/get_instance_pool.py +10 -11
- pulumi_databricks/get_instance_profiles.py +25 -9
- pulumi_databricks/get_job.py +22 -23
- pulumi_databricks/get_jobs.py +44 -26
- pulumi_databricks/get_materialized_features_feature_tag.py +102 -0
- pulumi_databricks/get_materialized_features_feature_tags.py +133 -0
- pulumi_databricks/get_metastore.py +28 -29
- pulumi_databricks/get_metastores.py +9 -10
- pulumi_databricks/get_mlflow_experiment.py +62 -46
- pulumi_databricks/get_mlflow_model.py +47 -31
- pulumi_databricks/get_mlflow_models.py +32 -14
- pulumi_databricks/get_mws_credentials.py +9 -10
- pulumi_databricks/get_mws_network_connectivity_config.py +40 -41
- pulumi_databricks/get_mws_network_connectivity_configs.py +15 -16
- pulumi_databricks/get_mws_workspaces.py +5 -6
- pulumi_databricks/get_node_type.py +123 -87
- pulumi_databricks/get_notebook.py +37 -38
- pulumi_databricks/get_notebook_paths.py +16 -17
- pulumi_databricks/get_notification_destinations.py +33 -18
- pulumi_databricks/get_online_store.py +36 -27
- pulumi_databricks/get_online_stores.py +33 -13
- pulumi_databricks/get_pipelines.py +49 -31
- pulumi_databricks/get_policy_info.py +338 -0
- pulumi_databricks/get_policy_infos.py +169 -0
- pulumi_databricks/get_quality_monitor_v2.py +21 -18
- pulumi_databricks/get_quality_monitors_v2.py +26 -8
- pulumi_databricks/get_registered_model.py +41 -27
- pulumi_databricks/get_registered_model_versions.py +29 -15
- pulumi_databricks/get_rfa_access_request_destinations.py +126 -0
- pulumi_databricks/get_schema.py +32 -16
- pulumi_databricks/get_schemas.py +38 -20
- pulumi_databricks/get_service_principal.py +80 -58
- pulumi_databricks/get_service_principal_federation_policies.py +151 -0
- pulumi_databricks/get_service_principal_federation_policy.py +220 -0
- pulumi_databricks/get_service_principals.py +16 -17
- pulumi_databricks/get_serving_endpoints.py +23 -9
- pulumi_databricks/get_share.py +130 -32
- pulumi_databricks/get_shares.py +29 -11
- pulumi_databricks/get_spark_version.py +87 -69
- pulumi_databricks/get_sql_warehouse.py +124 -110
- pulumi_databricks/get_sql_warehouses.py +37 -19
- pulumi_databricks/get_storage_credential.py +32 -16
- pulumi_databricks/get_storage_credentials.py +32 -14
- pulumi_databricks/get_table.py +30 -14
- pulumi_databricks/get_tables.py +41 -23
- pulumi_databricks/get_tag_policies.py +139 -0
- pulumi_databricks/get_tag_policy.py +175 -0
- pulumi_databricks/get_user.py +33 -34
- pulumi_databricks/get_views.py +41 -23
- pulumi_databricks/get_volume.py +32 -16
- pulumi_databricks/get_volumes.py +41 -23
- pulumi_databricks/get_workspace_network_option.py +45 -26
- pulumi_databricks/get_workspace_setting_v2.py +331 -0
- pulumi_databricks/get_zones.py +39 -21
- pulumi_databricks/git_credential.py +242 -76
- pulumi_databricks/global_init_script.py +99 -100
- pulumi_databricks/grant.py +215 -212
- pulumi_databricks/grants.py +200 -211
- pulumi_databricks/group.py +176 -177
- pulumi_databricks/group_instance_profile.py +37 -38
- pulumi_databricks/group_member.py +37 -38
- pulumi_databricks/group_role.py +37 -38
- pulumi_databricks/instance_pool.py +168 -169
- pulumi_databricks/instance_profile.py +69 -70
- pulumi_databricks/ip_access_list.py +71 -72
- pulumi_databricks/job.py +426 -346
- pulumi_databricks/lakehouse_monitor.py +199 -200
- pulumi_databricks/library.py +264 -99
- pulumi_databricks/materialized_features_feature_tag.py +213 -0
- pulumi_databricks/metastore.py +254 -255
- pulumi_databricks/metastore_assignment.py +52 -53
- pulumi_databricks/metastore_data_access.py +153 -154
- pulumi_databricks/metastore_provider.py +69 -70
- pulumi_databricks/mlflow_experiment.py +108 -109
- pulumi_databricks/mlflow_model.py +45 -46
- pulumi_databricks/mlflow_webhook.py +75 -76
- pulumi_databricks/model_serving.py +195 -74
- pulumi_databricks/model_serving_provisioned_throughput.py +100 -54
- pulumi_databricks/mount.py +103 -104
- pulumi_databricks/mws_credentials.py +99 -100
- pulumi_databricks/mws_customer_managed_keys.py +75 -76
- pulumi_databricks/mws_log_delivery.py +188 -189
- pulumi_databricks/mws_ncc_binding.py +35 -36
- pulumi_databricks/mws_ncc_private_endpoint_rule.py +312 -289
- pulumi_databricks/mws_network_connectivity_config.py +136 -98
- pulumi_databricks/mws_networks.py +159 -160
- pulumi_databricks/mws_permission_assignment.py +70 -71
- pulumi_databricks/mws_private_access_settings.py +116 -117
- pulumi_databricks/mws_storage_configurations.py +74 -75
- pulumi_databricks/mws_vpc_endpoint.py +149 -150
- pulumi_databricks/mws_workspaces.py +464 -418
- pulumi_databricks/notebook.py +143 -144
- pulumi_databricks/notification_destination.py +38 -39
- pulumi_databricks/obo_token.py +63 -64
- pulumi_databricks/online_store.py +121 -70
- pulumi_databricks/online_table.py +41 -42
- pulumi_databricks/outputs.py +47821 -30802
- pulumi_databricks/permission_assignment.py +298 -57
- pulumi_databricks/permissions.py +523 -362
- pulumi_databricks/pipeline.py +515 -480
- pulumi_databricks/policy_info.py +916 -0
- pulumi_databricks/provider.py +283 -269
- pulumi_databricks/pulumi-plugin.json +1 -1
- pulumi_databricks/quality_monitor.py +263 -217
- pulumi_databricks/quality_monitor_v2.py +49 -46
- pulumi_databricks/query.py +227 -228
- pulumi_databricks/recipient.py +208 -209
- pulumi_databricks/registered_model.py +393 -122
- pulumi_databricks/repo.py +117 -118
- pulumi_databricks/restrict_workspace_admins_setting.py +30 -31
- pulumi_databricks/rfa_access_request_destinations.py +286 -0
- pulumi_databricks/schema.py +159 -160
- pulumi_databricks/secret.py +72 -73
- pulumi_databricks/secret_acl.py +52 -53
- pulumi_databricks/secret_scope.py +55 -56
- pulumi_databricks/service_principal.py +279 -278
- pulumi_databricks/service_principal_federation_policy.py +469 -0
- pulumi_databricks/service_principal_role.py +35 -36
- pulumi_databricks/service_principal_secret.py +156 -157
- pulumi_databricks/share.py +186 -187
- pulumi_databricks/sql_alert.py +98 -99
- pulumi_databricks/sql_dashboard.py +94 -95
- pulumi_databricks/sql_endpoint.py +298 -266
- pulumi_databricks/sql_global_config.py +103 -104
- pulumi_databricks/sql_permissions.py +121 -122
- pulumi_databricks/sql_query.py +150 -151
- pulumi_databricks/sql_table.py +310 -283
- pulumi_databricks/sql_visualization.py +92 -93
- pulumi_databricks/sql_widget.py +91 -88
- pulumi_databricks/storage_credential.py +236 -184
- pulumi_databricks/system_schema.py +50 -51
- pulumi_databricks/table.py +147 -148
- pulumi_databricks/tag_policy.py +357 -0
- pulumi_databricks/token.py +83 -84
- pulumi_databricks/user.py +284 -285
- pulumi_databricks/user_instance_profile.py +35 -36
- pulumi_databricks/user_role.py +35 -36
- pulumi_databricks/vector_search_endpoint.py +117 -118
- pulumi_databricks/vector_search_index.py +86 -87
- pulumi_databricks/volume.py +129 -130
- pulumi_databricks/workspace_binding.py +82 -131
- pulumi_databricks/workspace_conf.py +18 -19
- pulumi_databricks/workspace_file.py +100 -101
- pulumi_databricks/workspace_network_option.py +89 -40
- pulumi_databricks/workspace_setting_v2.py +759 -0
- {pulumi_databricks-1.74.0a1753335781.dist-info → pulumi_databricks-1.77.0.dist-info}/METADATA +1 -1
- pulumi_databricks-1.77.0.dist-info/RECORD +250 -0
- pulumi_databricks/get_recipient_federation_policies.py +0 -83
- pulumi_databricks/get_recipient_federation_policy.py +0 -166
- pulumi_databricks/recipient_federation_policy.py +0 -347
- pulumi_databricks-1.74.0a1753335781.dist-info/RECORD +0 -205
- {pulumi_databricks-1.74.0a1753335781.dist-info → pulumi_databricks-1.77.0.dist-info}/WHEEL +0 -0
- {pulumi_databricks-1.74.0a1753335781.dist-info → pulumi_databricks-1.77.0.dist-info}/top_level.txt +0 -0
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
6
|
-
import copy
|
|
5
|
+
import builtins as _builtins
|
|
7
6
|
import warnings
|
|
8
7
|
import sys
|
|
9
8
|
import pulumi
|
|
@@ -14,236 +13,666 @@ if sys.version_info >= (3, 11):
|
|
|
14
13
|
else:
|
|
15
14
|
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
16
15
|
from . import _utilities
|
|
16
|
+
from . import outputs
|
|
17
|
+
from ._inputs import *
|
|
17
18
|
|
|
18
19
|
__all__ = ['DatabaseInstanceArgs', 'DatabaseInstance']
|
|
19
20
|
|
|
20
21
|
@pulumi.input_type
|
|
21
22
|
class DatabaseInstanceArgs:
|
|
22
23
|
def __init__(__self__, *,
|
|
23
|
-
capacity: Optional[pulumi.Input[
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
25
|
+
custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]] = None,
|
|
26
|
+
enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
27
|
+
enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
28
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
29
|
+
node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
30
|
+
parent_instance_ref: Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']] = None,
|
|
31
|
+
purge_on_delete: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
32
|
+
retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
33
|
+
stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
34
|
+
usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None):
|
|
26
35
|
"""
|
|
27
36
|
The set of arguments for constructing a DatabaseInstance resource.
|
|
28
|
-
:param pulumi.Input[
|
|
29
|
-
:param pulumi.Input[
|
|
30
|
-
:param pulumi.Input[
|
|
37
|
+
:param pulumi.Input[_builtins.str] capacity: The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
38
|
+
:param pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]] custom_tags: Custom tags associated with the instance. This field is only included on create and update responses
|
|
39
|
+
:param pulumi.Input[_builtins.bool] enable_pg_native_login: Whether to enable PG native password login on the instance. Defaults to false
|
|
40
|
+
:param pulumi.Input[_builtins.bool] enable_readable_secondaries: Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
41
|
+
:param pulumi.Input[_builtins.str] name: The name of the instance. This is the unique identifier for the instance
|
|
42
|
+
:param pulumi.Input[_builtins.int] node_count: The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
43
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
44
|
+
:param pulumi.Input['DatabaseInstanceParentInstanceRefArgs'] parent_instance_ref: The ref of the parent instance. This is only available if the instance is
|
|
45
|
+
child instance.
|
|
46
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
47
|
+
Output: Only populated if provided as input to create a child instance
|
|
48
|
+
:param pulumi.Input[_builtins.bool] purge_on_delete: Purge the resource on delete
|
|
49
|
+
:param pulumi.Input[_builtins.int] retention_window_in_days: The retention window for the instance. This is the time window in days
|
|
50
|
+
for which the historical data is retained. The default value is 7 days.
|
|
51
|
+
Valid values are 2 to 35 days
|
|
52
|
+
:param pulumi.Input[_builtins.bool] stopped: Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
53
|
+
:param pulumi.Input[_builtins.str] usage_policy_id: The desired usage policy to associate with the instance
|
|
31
54
|
"""
|
|
32
55
|
if capacity is not None:
|
|
33
56
|
pulumi.set(__self__, "capacity", capacity)
|
|
57
|
+
if custom_tags is not None:
|
|
58
|
+
pulumi.set(__self__, "custom_tags", custom_tags)
|
|
59
|
+
if enable_pg_native_login is not None:
|
|
60
|
+
pulumi.set(__self__, "enable_pg_native_login", enable_pg_native_login)
|
|
61
|
+
if enable_readable_secondaries is not None:
|
|
62
|
+
pulumi.set(__self__, "enable_readable_secondaries", enable_readable_secondaries)
|
|
34
63
|
if name is not None:
|
|
35
64
|
pulumi.set(__self__, "name", name)
|
|
65
|
+
if node_count is not None:
|
|
66
|
+
pulumi.set(__self__, "node_count", node_count)
|
|
67
|
+
if parent_instance_ref is not None:
|
|
68
|
+
pulumi.set(__self__, "parent_instance_ref", parent_instance_ref)
|
|
69
|
+
if purge_on_delete is not None:
|
|
70
|
+
pulumi.set(__self__, "purge_on_delete", purge_on_delete)
|
|
71
|
+
if retention_window_in_days is not None:
|
|
72
|
+
pulumi.set(__self__, "retention_window_in_days", retention_window_in_days)
|
|
36
73
|
if stopped is not None:
|
|
37
74
|
pulumi.set(__self__, "stopped", stopped)
|
|
75
|
+
if usage_policy_id is not None:
|
|
76
|
+
pulumi.set(__self__, "usage_policy_id", usage_policy_id)
|
|
38
77
|
|
|
39
|
-
@property
|
|
78
|
+
@_builtins.property
|
|
40
79
|
@pulumi.getter
|
|
41
|
-
def capacity(self) -> Optional[pulumi.Input[
|
|
80
|
+
def capacity(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
42
81
|
"""
|
|
43
82
|
The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
44
83
|
"""
|
|
45
84
|
return pulumi.get(self, "capacity")
|
|
46
85
|
|
|
47
86
|
@capacity.setter
|
|
48
|
-
def capacity(self, value: Optional[pulumi.Input[
|
|
87
|
+
def capacity(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
49
88
|
pulumi.set(self, "capacity", value)
|
|
50
89
|
|
|
51
|
-
@property
|
|
90
|
+
@_builtins.property
|
|
91
|
+
@pulumi.getter(name="customTags")
|
|
92
|
+
def custom_tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]]:
|
|
93
|
+
"""
|
|
94
|
+
Custom tags associated with the instance. This field is only included on create and update responses
|
|
95
|
+
"""
|
|
96
|
+
return pulumi.get(self, "custom_tags")
|
|
97
|
+
|
|
98
|
+
@custom_tags.setter
|
|
99
|
+
def custom_tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]]):
|
|
100
|
+
pulumi.set(self, "custom_tags", value)
|
|
101
|
+
|
|
102
|
+
@_builtins.property
|
|
103
|
+
@pulumi.getter(name="enablePgNativeLogin")
|
|
104
|
+
def enable_pg_native_login(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
105
|
+
"""
|
|
106
|
+
Whether to enable PG native password login on the instance. Defaults to false
|
|
107
|
+
"""
|
|
108
|
+
return pulumi.get(self, "enable_pg_native_login")
|
|
109
|
+
|
|
110
|
+
@enable_pg_native_login.setter
|
|
111
|
+
def enable_pg_native_login(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
112
|
+
pulumi.set(self, "enable_pg_native_login", value)
|
|
113
|
+
|
|
114
|
+
@_builtins.property
|
|
115
|
+
@pulumi.getter(name="enableReadableSecondaries")
|
|
116
|
+
def enable_readable_secondaries(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
117
|
+
"""
|
|
118
|
+
Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
119
|
+
"""
|
|
120
|
+
return pulumi.get(self, "enable_readable_secondaries")
|
|
121
|
+
|
|
122
|
+
@enable_readable_secondaries.setter
|
|
123
|
+
def enable_readable_secondaries(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
124
|
+
pulumi.set(self, "enable_readable_secondaries", value)
|
|
125
|
+
|
|
126
|
+
@_builtins.property
|
|
52
127
|
@pulumi.getter
|
|
53
|
-
def name(self) -> Optional[pulumi.Input[
|
|
128
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
54
129
|
"""
|
|
55
130
|
The name of the instance. This is the unique identifier for the instance
|
|
56
131
|
"""
|
|
57
132
|
return pulumi.get(self, "name")
|
|
58
133
|
|
|
59
134
|
@name.setter
|
|
60
|
-
def name(self, value: Optional[pulumi.Input[
|
|
135
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
61
136
|
pulumi.set(self, "name", value)
|
|
62
137
|
|
|
63
|
-
@property
|
|
138
|
+
@_builtins.property
|
|
139
|
+
@pulumi.getter(name="nodeCount")
|
|
140
|
+
def node_count(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
141
|
+
"""
|
|
142
|
+
The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
143
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
144
|
+
"""
|
|
145
|
+
return pulumi.get(self, "node_count")
|
|
146
|
+
|
|
147
|
+
@node_count.setter
|
|
148
|
+
def node_count(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
149
|
+
pulumi.set(self, "node_count", value)
|
|
150
|
+
|
|
151
|
+
@_builtins.property
|
|
152
|
+
@pulumi.getter(name="parentInstanceRef")
|
|
153
|
+
def parent_instance_ref(self) -> Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']]:
|
|
154
|
+
"""
|
|
155
|
+
The ref of the parent instance. This is only available if the instance is
|
|
156
|
+
child instance.
|
|
157
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
158
|
+
Output: Only populated if provided as input to create a child instance
|
|
159
|
+
"""
|
|
160
|
+
return pulumi.get(self, "parent_instance_ref")
|
|
161
|
+
|
|
162
|
+
@parent_instance_ref.setter
|
|
163
|
+
def parent_instance_ref(self, value: Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']]):
|
|
164
|
+
pulumi.set(self, "parent_instance_ref", value)
|
|
165
|
+
|
|
166
|
+
@_builtins.property
|
|
167
|
+
@pulumi.getter(name="purgeOnDelete")
|
|
168
|
+
def purge_on_delete(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
169
|
+
"""
|
|
170
|
+
Purge the resource on delete
|
|
171
|
+
"""
|
|
172
|
+
return pulumi.get(self, "purge_on_delete")
|
|
173
|
+
|
|
174
|
+
@purge_on_delete.setter
|
|
175
|
+
def purge_on_delete(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
176
|
+
pulumi.set(self, "purge_on_delete", value)
|
|
177
|
+
|
|
178
|
+
@_builtins.property
|
|
179
|
+
@pulumi.getter(name="retentionWindowInDays")
|
|
180
|
+
def retention_window_in_days(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
181
|
+
"""
|
|
182
|
+
The retention window for the instance. This is the time window in days
|
|
183
|
+
for which the historical data is retained. The default value is 7 days.
|
|
184
|
+
Valid values are 2 to 35 days
|
|
185
|
+
"""
|
|
186
|
+
return pulumi.get(self, "retention_window_in_days")
|
|
187
|
+
|
|
188
|
+
@retention_window_in_days.setter
|
|
189
|
+
def retention_window_in_days(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
190
|
+
pulumi.set(self, "retention_window_in_days", value)
|
|
191
|
+
|
|
192
|
+
@_builtins.property
|
|
64
193
|
@pulumi.getter
|
|
65
|
-
def stopped(self) -> Optional[pulumi.Input[
|
|
194
|
+
def stopped(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
66
195
|
"""
|
|
67
|
-
Whether the instance
|
|
196
|
+
Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
68
197
|
"""
|
|
69
198
|
return pulumi.get(self, "stopped")
|
|
70
199
|
|
|
71
200
|
@stopped.setter
|
|
72
|
-
def stopped(self, value: Optional[pulumi.Input[
|
|
201
|
+
def stopped(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
73
202
|
pulumi.set(self, "stopped", value)
|
|
74
203
|
|
|
204
|
+
@_builtins.property
|
|
205
|
+
@pulumi.getter(name="usagePolicyId")
|
|
206
|
+
def usage_policy_id(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
207
|
+
"""
|
|
208
|
+
The desired usage policy to associate with the instance
|
|
209
|
+
"""
|
|
210
|
+
return pulumi.get(self, "usage_policy_id")
|
|
211
|
+
|
|
212
|
+
@usage_policy_id.setter
|
|
213
|
+
def usage_policy_id(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
214
|
+
pulumi.set(self, "usage_policy_id", value)
|
|
215
|
+
|
|
75
216
|
|
|
76
217
|
@pulumi.input_type
|
|
77
218
|
class _DatabaseInstanceState:
|
|
78
219
|
def __init__(__self__, *,
|
|
79
|
-
capacity: Optional[pulumi.Input[
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
220
|
+
capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
221
|
+
child_instance_refs: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceChildInstanceRefArgs']]]] = None,
|
|
222
|
+
creation_time: Optional[pulumi.Input[_builtins.str]] = None,
|
|
223
|
+
creator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
224
|
+
custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]] = None,
|
|
225
|
+
effective_capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
226
|
+
effective_custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceEffectiveCustomTagArgs']]]] = None,
|
|
227
|
+
effective_enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
228
|
+
effective_enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
229
|
+
effective_node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
230
|
+
effective_retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
231
|
+
effective_stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
232
|
+
effective_usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
233
|
+
enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
234
|
+
enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
235
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
236
|
+
node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
237
|
+
parent_instance_ref: Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']] = None,
|
|
238
|
+
pg_version: Optional[pulumi.Input[_builtins.str]] = None,
|
|
239
|
+
purge_on_delete: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
240
|
+
read_only_dns: Optional[pulumi.Input[_builtins.str]] = None,
|
|
241
|
+
read_write_dns: Optional[pulumi.Input[_builtins.str]] = None,
|
|
242
|
+
retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
243
|
+
state: Optional[pulumi.Input[_builtins.str]] = None,
|
|
244
|
+
stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
245
|
+
uid: Optional[pulumi.Input[_builtins.str]] = None,
|
|
246
|
+
usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None):
|
|
89
247
|
"""
|
|
90
248
|
Input properties used for looking up and filtering DatabaseInstance resources.
|
|
91
|
-
:param pulumi.Input[
|
|
92
|
-
:param pulumi.Input[
|
|
93
|
-
|
|
94
|
-
:param pulumi.Input[
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
:param pulumi.Input[
|
|
98
|
-
:param pulumi.Input[
|
|
99
|
-
:param pulumi.Input[
|
|
100
|
-
:param pulumi.Input[
|
|
101
|
-
:param pulumi.Input[
|
|
102
|
-
|
|
249
|
+
:param pulumi.Input[_builtins.str] capacity: The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
250
|
+
:param pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceChildInstanceRefArgs']]] child_instance_refs: (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is
|
|
251
|
+
parent instance
|
|
252
|
+
:param pulumi.Input[_builtins.str] creation_time: (string) - The timestamp when the instance was created
|
|
253
|
+
:param pulumi.Input[_builtins.str] creator: (string) - The email of the creator of the instance
|
|
254
|
+
:param pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]] custom_tags: Custom tags associated with the instance. This field is only included on create and update responses
|
|
255
|
+
:param pulumi.Input[_builtins.str] effective_capacity: (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
|
|
256
|
+
:param pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceEffectiveCustomTagArgs']]] effective_custom_tags: (list of CustomTag) - The recorded custom tags associated with the instance
|
|
257
|
+
:param pulumi.Input[_builtins.bool] effective_enable_pg_native_login: (boolean) - Whether the instance has PG native password login enabled
|
|
258
|
+
:param pulumi.Input[_builtins.bool] effective_enable_readable_secondaries: (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
|
|
259
|
+
:param pulumi.Input[_builtins.int] effective_node_count: (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
260
|
+
1 primary and 0 secondaries
|
|
261
|
+
:param pulumi.Input[_builtins.int] effective_retention_window_in_days: (integer) - The retention window for the instance. This is the time window in days
|
|
262
|
+
for which the historical data is retained
|
|
263
|
+
:param pulumi.Input[_builtins.bool] effective_stopped: (boolean) - Whether the instance is stopped
|
|
264
|
+
:param pulumi.Input[_builtins.str] effective_usage_policy_id: (string) - The policy that is applied to the instance
|
|
265
|
+
:param pulumi.Input[_builtins.bool] enable_pg_native_login: Whether to enable PG native password login on the instance. Defaults to false
|
|
266
|
+
:param pulumi.Input[_builtins.bool] enable_readable_secondaries: Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
267
|
+
:param pulumi.Input[_builtins.str] name: The name of the instance. This is the unique identifier for the instance
|
|
268
|
+
:param pulumi.Input[_builtins.int] node_count: The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
269
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
270
|
+
:param pulumi.Input['DatabaseInstanceParentInstanceRefArgs'] parent_instance_ref: The ref of the parent instance. This is only available if the instance is
|
|
271
|
+
child instance.
|
|
272
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
273
|
+
Output: Only populated if provided as input to create a child instance
|
|
274
|
+
:param pulumi.Input[_builtins.str] pg_version: (string) - The version of Postgres running on the instance
|
|
275
|
+
:param pulumi.Input[_builtins.bool] purge_on_delete: Purge the resource on delete
|
|
276
|
+
:param pulumi.Input[_builtins.str] read_only_dns: (string) - The DNS endpoint to connect to the instance for read only access. This is only available if
|
|
277
|
+
enable_readable_secondaries is true
|
|
278
|
+
:param pulumi.Input[_builtins.str] read_write_dns: (string) - The DNS endpoint to connect to the instance for read+write access
|
|
279
|
+
:param pulumi.Input[_builtins.int] retention_window_in_days: The retention window for the instance. This is the time window in days
|
|
280
|
+
for which the historical data is retained. The default value is 7 days.
|
|
281
|
+
Valid values are 2 to 35 days
|
|
282
|
+
:param pulumi.Input[_builtins.str] state: (string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
|
|
283
|
+
:param pulumi.Input[_builtins.bool] stopped: Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
284
|
+
:param pulumi.Input[_builtins.str] uid: (string) - Id of the ref database instance
|
|
285
|
+
:param pulumi.Input[_builtins.str] usage_policy_id: The desired usage policy to associate with the instance
|
|
103
286
|
"""
|
|
104
287
|
if capacity is not None:
|
|
105
288
|
pulumi.set(__self__, "capacity", capacity)
|
|
289
|
+
if child_instance_refs is not None:
|
|
290
|
+
pulumi.set(__self__, "child_instance_refs", child_instance_refs)
|
|
106
291
|
if creation_time is not None:
|
|
107
292
|
pulumi.set(__self__, "creation_time", creation_time)
|
|
108
293
|
if creator is not None:
|
|
109
294
|
pulumi.set(__self__, "creator", creator)
|
|
295
|
+
if custom_tags is not None:
|
|
296
|
+
pulumi.set(__self__, "custom_tags", custom_tags)
|
|
297
|
+
if effective_capacity is not None:
|
|
298
|
+
pulumi.set(__self__, "effective_capacity", effective_capacity)
|
|
299
|
+
if effective_custom_tags is not None:
|
|
300
|
+
pulumi.set(__self__, "effective_custom_tags", effective_custom_tags)
|
|
301
|
+
if effective_enable_pg_native_login is not None:
|
|
302
|
+
pulumi.set(__self__, "effective_enable_pg_native_login", effective_enable_pg_native_login)
|
|
303
|
+
if effective_enable_readable_secondaries is not None:
|
|
304
|
+
pulumi.set(__self__, "effective_enable_readable_secondaries", effective_enable_readable_secondaries)
|
|
305
|
+
if effective_node_count is not None:
|
|
306
|
+
pulumi.set(__self__, "effective_node_count", effective_node_count)
|
|
307
|
+
if effective_retention_window_in_days is not None:
|
|
308
|
+
pulumi.set(__self__, "effective_retention_window_in_days", effective_retention_window_in_days)
|
|
110
309
|
if effective_stopped is not None:
|
|
111
310
|
pulumi.set(__self__, "effective_stopped", effective_stopped)
|
|
311
|
+
if effective_usage_policy_id is not None:
|
|
312
|
+
pulumi.set(__self__, "effective_usage_policy_id", effective_usage_policy_id)
|
|
313
|
+
if enable_pg_native_login is not None:
|
|
314
|
+
pulumi.set(__self__, "enable_pg_native_login", enable_pg_native_login)
|
|
315
|
+
if enable_readable_secondaries is not None:
|
|
316
|
+
pulumi.set(__self__, "enable_readable_secondaries", enable_readable_secondaries)
|
|
112
317
|
if name is not None:
|
|
113
318
|
pulumi.set(__self__, "name", name)
|
|
319
|
+
if node_count is not None:
|
|
320
|
+
pulumi.set(__self__, "node_count", node_count)
|
|
321
|
+
if parent_instance_ref is not None:
|
|
322
|
+
pulumi.set(__self__, "parent_instance_ref", parent_instance_ref)
|
|
114
323
|
if pg_version is not None:
|
|
115
324
|
pulumi.set(__self__, "pg_version", pg_version)
|
|
325
|
+
if purge_on_delete is not None:
|
|
326
|
+
pulumi.set(__self__, "purge_on_delete", purge_on_delete)
|
|
327
|
+
if read_only_dns is not None:
|
|
328
|
+
pulumi.set(__self__, "read_only_dns", read_only_dns)
|
|
116
329
|
if read_write_dns is not None:
|
|
117
330
|
pulumi.set(__self__, "read_write_dns", read_write_dns)
|
|
331
|
+
if retention_window_in_days is not None:
|
|
332
|
+
pulumi.set(__self__, "retention_window_in_days", retention_window_in_days)
|
|
118
333
|
if state is not None:
|
|
119
334
|
pulumi.set(__self__, "state", state)
|
|
120
335
|
if stopped is not None:
|
|
121
336
|
pulumi.set(__self__, "stopped", stopped)
|
|
122
337
|
if uid is not None:
|
|
123
338
|
pulumi.set(__self__, "uid", uid)
|
|
339
|
+
if usage_policy_id is not None:
|
|
340
|
+
pulumi.set(__self__, "usage_policy_id", usage_policy_id)
|
|
124
341
|
|
|
125
|
-
@property
|
|
342
|
+
@_builtins.property
|
|
126
343
|
@pulumi.getter
|
|
127
|
-
def capacity(self) -> Optional[pulumi.Input[
|
|
344
|
+
def capacity(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
128
345
|
"""
|
|
129
346
|
The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
130
347
|
"""
|
|
131
348
|
return pulumi.get(self, "capacity")
|
|
132
349
|
|
|
133
350
|
@capacity.setter
|
|
134
|
-
def capacity(self, value: Optional[pulumi.Input[
|
|
351
|
+
def capacity(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
135
352
|
pulumi.set(self, "capacity", value)
|
|
136
353
|
|
|
137
|
-
@property
|
|
354
|
+
@_builtins.property
|
|
355
|
+
@pulumi.getter(name="childInstanceRefs")
|
|
356
|
+
def child_instance_refs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceChildInstanceRefArgs']]]]:
|
|
357
|
+
"""
|
|
358
|
+
(list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is
|
|
359
|
+
parent instance
|
|
360
|
+
"""
|
|
361
|
+
return pulumi.get(self, "child_instance_refs")
|
|
362
|
+
|
|
363
|
+
@child_instance_refs.setter
|
|
364
|
+
def child_instance_refs(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceChildInstanceRefArgs']]]]):
|
|
365
|
+
pulumi.set(self, "child_instance_refs", value)
|
|
366
|
+
|
|
367
|
+
@_builtins.property
|
|
138
368
|
@pulumi.getter(name="creationTime")
|
|
139
|
-
def creation_time(self) -> Optional[pulumi.Input[
|
|
369
|
+
def creation_time(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
140
370
|
"""
|
|
141
371
|
(string) - The timestamp when the instance was created
|
|
142
372
|
"""
|
|
143
373
|
return pulumi.get(self, "creation_time")
|
|
144
374
|
|
|
145
375
|
@creation_time.setter
|
|
146
|
-
def creation_time(self, value: Optional[pulumi.Input[
|
|
376
|
+
def creation_time(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
147
377
|
pulumi.set(self, "creation_time", value)
|
|
148
378
|
|
|
149
|
-
@property
|
|
379
|
+
@_builtins.property
|
|
150
380
|
@pulumi.getter
|
|
151
|
-
def creator(self) -> Optional[pulumi.Input[
|
|
381
|
+
def creator(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
152
382
|
"""
|
|
153
383
|
(string) - The email of the creator of the instance
|
|
154
384
|
"""
|
|
155
385
|
return pulumi.get(self, "creator")
|
|
156
386
|
|
|
157
387
|
@creator.setter
|
|
158
|
-
def creator(self, value: Optional[pulumi.Input[
|
|
388
|
+
def creator(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
159
389
|
pulumi.set(self, "creator", value)
|
|
160
390
|
|
|
161
|
-
@property
|
|
391
|
+
@_builtins.property
|
|
392
|
+
@pulumi.getter(name="customTags")
|
|
393
|
+
def custom_tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]]:
|
|
394
|
+
"""
|
|
395
|
+
Custom tags associated with the instance. This field is only included on create and update responses
|
|
396
|
+
"""
|
|
397
|
+
return pulumi.get(self, "custom_tags")
|
|
398
|
+
|
|
399
|
+
@custom_tags.setter
|
|
400
|
+
def custom_tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceCustomTagArgs']]]]):
|
|
401
|
+
pulumi.set(self, "custom_tags", value)
|
|
402
|
+
|
|
403
|
+
@_builtins.property
|
|
404
|
+
@pulumi.getter(name="effectiveCapacity")
|
|
405
|
+
def effective_capacity(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
406
|
+
"""
|
|
407
|
+
(string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
|
|
408
|
+
"""
|
|
409
|
+
return pulumi.get(self, "effective_capacity")
|
|
410
|
+
|
|
411
|
+
@effective_capacity.setter
|
|
412
|
+
def effective_capacity(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
413
|
+
pulumi.set(self, "effective_capacity", value)
|
|
414
|
+
|
|
415
|
+
@_builtins.property
|
|
416
|
+
@pulumi.getter(name="effectiveCustomTags")
|
|
417
|
+
def effective_custom_tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceEffectiveCustomTagArgs']]]]:
|
|
418
|
+
"""
|
|
419
|
+
(list of CustomTag) - The recorded custom tags associated with the instance
|
|
420
|
+
"""
|
|
421
|
+
return pulumi.get(self, "effective_custom_tags")
|
|
422
|
+
|
|
423
|
+
@effective_custom_tags.setter
|
|
424
|
+
def effective_custom_tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['DatabaseInstanceEffectiveCustomTagArgs']]]]):
|
|
425
|
+
pulumi.set(self, "effective_custom_tags", value)
|
|
426
|
+
|
|
427
|
+
@_builtins.property
|
|
428
|
+
@pulumi.getter(name="effectiveEnablePgNativeLogin")
|
|
429
|
+
def effective_enable_pg_native_login(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
430
|
+
"""
|
|
431
|
+
(boolean) - Whether the instance has PG native password login enabled
|
|
432
|
+
"""
|
|
433
|
+
return pulumi.get(self, "effective_enable_pg_native_login")
|
|
434
|
+
|
|
435
|
+
@effective_enable_pg_native_login.setter
|
|
436
|
+
def effective_enable_pg_native_login(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
437
|
+
pulumi.set(self, "effective_enable_pg_native_login", value)
|
|
438
|
+
|
|
439
|
+
@_builtins.property
|
|
440
|
+
@pulumi.getter(name="effectiveEnableReadableSecondaries")
|
|
441
|
+
def effective_enable_readable_secondaries(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
442
|
+
"""
|
|
443
|
+
(boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
|
|
444
|
+
"""
|
|
445
|
+
return pulumi.get(self, "effective_enable_readable_secondaries")
|
|
446
|
+
|
|
447
|
+
@effective_enable_readable_secondaries.setter
|
|
448
|
+
def effective_enable_readable_secondaries(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
449
|
+
pulumi.set(self, "effective_enable_readable_secondaries", value)
|
|
450
|
+
|
|
451
|
+
@_builtins.property
|
|
452
|
+
@pulumi.getter(name="effectiveNodeCount")
|
|
453
|
+
def effective_node_count(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
454
|
+
"""
|
|
455
|
+
(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
456
|
+
1 primary and 0 secondaries
|
|
457
|
+
"""
|
|
458
|
+
return pulumi.get(self, "effective_node_count")
|
|
459
|
+
|
|
460
|
+
@effective_node_count.setter
|
|
461
|
+
def effective_node_count(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
462
|
+
pulumi.set(self, "effective_node_count", value)
|
|
463
|
+
|
|
464
|
+
@_builtins.property
|
|
465
|
+
@pulumi.getter(name="effectiveRetentionWindowInDays")
|
|
466
|
+
def effective_retention_window_in_days(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
467
|
+
"""
|
|
468
|
+
(integer) - The retention window for the instance. This is the time window in days
|
|
469
|
+
for which the historical data is retained
|
|
470
|
+
"""
|
|
471
|
+
return pulumi.get(self, "effective_retention_window_in_days")
|
|
472
|
+
|
|
473
|
+
@effective_retention_window_in_days.setter
|
|
474
|
+
def effective_retention_window_in_days(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
475
|
+
pulumi.set(self, "effective_retention_window_in_days", value)
|
|
476
|
+
|
|
477
|
+
@_builtins.property
|
|
162
478
|
@pulumi.getter(name="effectiveStopped")
|
|
163
|
-
def effective_stopped(self) -> Optional[pulumi.Input[
|
|
479
|
+
def effective_stopped(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
164
480
|
"""
|
|
165
|
-
(boolean) -
|
|
166
|
-
`stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.
|
|
167
|
-
`effective_stopped` on the other hand will always bet set in all response messages (Create/Update/Get/List)
|
|
481
|
+
(boolean) - Whether the instance is stopped
|
|
168
482
|
"""
|
|
169
483
|
return pulumi.get(self, "effective_stopped")
|
|
170
484
|
|
|
171
485
|
@effective_stopped.setter
|
|
172
|
-
def effective_stopped(self, value: Optional[pulumi.Input[
|
|
486
|
+
def effective_stopped(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
173
487
|
pulumi.set(self, "effective_stopped", value)
|
|
174
488
|
|
|
175
|
-
@property
|
|
489
|
+
@_builtins.property
|
|
490
|
+
@pulumi.getter(name="effectiveUsagePolicyId")
|
|
491
|
+
def effective_usage_policy_id(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
492
|
+
"""
|
|
493
|
+
(string) - The policy that is applied to the instance
|
|
494
|
+
"""
|
|
495
|
+
return pulumi.get(self, "effective_usage_policy_id")
|
|
496
|
+
|
|
497
|
+
@effective_usage_policy_id.setter
|
|
498
|
+
def effective_usage_policy_id(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
499
|
+
pulumi.set(self, "effective_usage_policy_id", value)
|
|
500
|
+
|
|
501
|
+
@_builtins.property
|
|
502
|
+
@pulumi.getter(name="enablePgNativeLogin")
|
|
503
|
+
def enable_pg_native_login(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
504
|
+
"""
|
|
505
|
+
Whether to enable PG native password login on the instance. Defaults to false
|
|
506
|
+
"""
|
|
507
|
+
return pulumi.get(self, "enable_pg_native_login")
|
|
508
|
+
|
|
509
|
+
@enable_pg_native_login.setter
|
|
510
|
+
def enable_pg_native_login(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
511
|
+
pulumi.set(self, "enable_pg_native_login", value)
|
|
512
|
+
|
|
513
|
+
@_builtins.property
|
|
514
|
+
@pulumi.getter(name="enableReadableSecondaries")
|
|
515
|
+
def enable_readable_secondaries(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
516
|
+
"""
|
|
517
|
+
Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
518
|
+
"""
|
|
519
|
+
return pulumi.get(self, "enable_readable_secondaries")
|
|
520
|
+
|
|
521
|
+
@enable_readable_secondaries.setter
|
|
522
|
+
def enable_readable_secondaries(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
523
|
+
pulumi.set(self, "enable_readable_secondaries", value)
|
|
524
|
+
|
|
525
|
+
@_builtins.property
|
|
176
526
|
@pulumi.getter
|
|
177
|
-
def name(self) -> Optional[pulumi.Input[
|
|
527
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
178
528
|
"""
|
|
179
529
|
The name of the instance. This is the unique identifier for the instance
|
|
180
530
|
"""
|
|
181
531
|
return pulumi.get(self, "name")
|
|
182
532
|
|
|
183
533
|
@name.setter
|
|
184
|
-
def name(self, value: Optional[pulumi.Input[
|
|
534
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
185
535
|
pulumi.set(self, "name", value)
|
|
186
536
|
|
|
187
|
-
@property
|
|
537
|
+
@_builtins.property
|
|
538
|
+
@pulumi.getter(name="nodeCount")
|
|
539
|
+
def node_count(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
540
|
+
"""
|
|
541
|
+
The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
542
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
543
|
+
"""
|
|
544
|
+
return pulumi.get(self, "node_count")
|
|
545
|
+
|
|
546
|
+
@node_count.setter
|
|
547
|
+
def node_count(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
548
|
+
pulumi.set(self, "node_count", value)
|
|
549
|
+
|
|
550
|
+
@_builtins.property
|
|
551
|
+
@pulumi.getter(name="parentInstanceRef")
|
|
552
|
+
def parent_instance_ref(self) -> Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']]:
|
|
553
|
+
"""
|
|
554
|
+
The ref of the parent instance. This is only available if the instance is
|
|
555
|
+
child instance.
|
|
556
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
557
|
+
Output: Only populated if provided as input to create a child instance
|
|
558
|
+
"""
|
|
559
|
+
return pulumi.get(self, "parent_instance_ref")
|
|
560
|
+
|
|
561
|
+
@parent_instance_ref.setter
|
|
562
|
+
def parent_instance_ref(self, value: Optional[pulumi.Input['DatabaseInstanceParentInstanceRefArgs']]):
|
|
563
|
+
pulumi.set(self, "parent_instance_ref", value)
|
|
564
|
+
|
|
565
|
+
@_builtins.property
|
|
188
566
|
@pulumi.getter(name="pgVersion")
|
|
189
|
-
def pg_version(self) -> Optional[pulumi.Input[
|
|
567
|
+
def pg_version(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
190
568
|
"""
|
|
191
569
|
(string) - The version of Postgres running on the instance
|
|
192
570
|
"""
|
|
193
571
|
return pulumi.get(self, "pg_version")
|
|
194
572
|
|
|
195
573
|
@pg_version.setter
|
|
196
|
-
def pg_version(self, value: Optional[pulumi.Input[
|
|
574
|
+
def pg_version(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
197
575
|
pulumi.set(self, "pg_version", value)
|
|
198
576
|
|
|
199
|
-
@property
|
|
577
|
+
@_builtins.property
|
|
578
|
+
@pulumi.getter(name="purgeOnDelete")
|
|
579
|
+
def purge_on_delete(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
580
|
+
"""
|
|
581
|
+
Purge the resource on delete
|
|
582
|
+
"""
|
|
583
|
+
return pulumi.get(self, "purge_on_delete")
|
|
584
|
+
|
|
585
|
+
@purge_on_delete.setter
|
|
586
|
+
def purge_on_delete(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
587
|
+
pulumi.set(self, "purge_on_delete", value)
|
|
588
|
+
|
|
589
|
+
@_builtins.property
|
|
590
|
+
@pulumi.getter(name="readOnlyDns")
|
|
591
|
+
def read_only_dns(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
592
|
+
"""
|
|
593
|
+
(string) - The DNS endpoint to connect to the instance for read only access. This is only available if
|
|
594
|
+
enable_readable_secondaries is true
|
|
595
|
+
"""
|
|
596
|
+
return pulumi.get(self, "read_only_dns")
|
|
597
|
+
|
|
598
|
+
@read_only_dns.setter
|
|
599
|
+
def read_only_dns(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
600
|
+
pulumi.set(self, "read_only_dns", value)
|
|
601
|
+
|
|
602
|
+
@_builtins.property
|
|
200
603
|
@pulumi.getter(name="readWriteDns")
|
|
201
|
-
def read_write_dns(self) -> Optional[pulumi.Input[
|
|
604
|
+
def read_write_dns(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
202
605
|
"""
|
|
203
606
|
(string) - The DNS endpoint to connect to the instance for read+write access
|
|
204
607
|
"""
|
|
205
608
|
return pulumi.get(self, "read_write_dns")
|
|
206
609
|
|
|
207
610
|
@read_write_dns.setter
|
|
208
|
-
def read_write_dns(self, value: Optional[pulumi.Input[
|
|
611
|
+
def read_write_dns(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
209
612
|
pulumi.set(self, "read_write_dns", value)
|
|
210
613
|
|
|
211
|
-
@property
|
|
614
|
+
@_builtins.property
|
|
615
|
+
@pulumi.getter(name="retentionWindowInDays")
|
|
616
|
+
def retention_window_in_days(self) -> Optional[pulumi.Input[_builtins.int]]:
|
|
617
|
+
"""
|
|
618
|
+
The retention window for the instance. This is the time window in days
|
|
619
|
+
for which the historical data is retained. The default value is 7 days.
|
|
620
|
+
Valid values are 2 to 35 days
|
|
621
|
+
"""
|
|
622
|
+
return pulumi.get(self, "retention_window_in_days")
|
|
623
|
+
|
|
624
|
+
@retention_window_in_days.setter
|
|
625
|
+
def retention_window_in_days(self, value: Optional[pulumi.Input[_builtins.int]]):
|
|
626
|
+
pulumi.set(self, "retention_window_in_days", value)
|
|
627
|
+
|
|
628
|
+
@_builtins.property
|
|
212
629
|
@pulumi.getter
|
|
213
|
-
def state(self) -> Optional[pulumi.Input[
|
|
630
|
+
def state(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
214
631
|
"""
|
|
215
632
|
(string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
|
|
216
633
|
"""
|
|
217
634
|
return pulumi.get(self, "state")
|
|
218
635
|
|
|
219
636
|
@state.setter
|
|
220
|
-
def state(self, value: Optional[pulumi.Input[
|
|
637
|
+
def state(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
221
638
|
pulumi.set(self, "state", value)
|
|
222
639
|
|
|
223
|
-
@property
|
|
640
|
+
@_builtins.property
|
|
224
641
|
@pulumi.getter
|
|
225
|
-
def stopped(self) -> Optional[pulumi.Input[
|
|
642
|
+
def stopped(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
226
643
|
"""
|
|
227
|
-
Whether the instance
|
|
644
|
+
Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
228
645
|
"""
|
|
229
646
|
return pulumi.get(self, "stopped")
|
|
230
647
|
|
|
231
648
|
@stopped.setter
|
|
232
|
-
def stopped(self, value: Optional[pulumi.Input[
|
|
649
|
+
def stopped(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
233
650
|
pulumi.set(self, "stopped", value)
|
|
234
651
|
|
|
235
|
-
@property
|
|
652
|
+
@_builtins.property
|
|
236
653
|
@pulumi.getter
|
|
237
|
-
def uid(self) -> Optional[pulumi.Input[
|
|
654
|
+
def uid(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
238
655
|
"""
|
|
239
|
-
(string) -
|
|
656
|
+
(string) - Id of the ref database instance
|
|
240
657
|
"""
|
|
241
658
|
return pulumi.get(self, "uid")
|
|
242
659
|
|
|
243
660
|
@uid.setter
|
|
244
|
-
def uid(self, value: Optional[pulumi.Input[
|
|
661
|
+
def uid(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
245
662
|
pulumi.set(self, "uid", value)
|
|
246
663
|
|
|
664
|
+
@_builtins.property
|
|
665
|
+
@pulumi.getter(name="usagePolicyId")
|
|
666
|
+
def usage_policy_id(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
667
|
+
"""
|
|
668
|
+
The desired usage policy to associate with the instance
|
|
669
|
+
"""
|
|
670
|
+
return pulumi.get(self, "usage_policy_id")
|
|
671
|
+
|
|
672
|
+
@usage_policy_id.setter
|
|
673
|
+
def usage_policy_id(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
674
|
+
pulumi.set(self, "usage_policy_id", value)
|
|
675
|
+
|
|
247
676
|
|
|
248
677
|
@pulumi.type_token("databricks:index/databaseInstance:DatabaseInstance")
|
|
249
678
|
class DatabaseInstance(pulumi.CustomResource):
|
|
@@ -251,15 +680,29 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
251
680
|
def __init__(__self__,
|
|
252
681
|
resource_name: str,
|
|
253
682
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
254
|
-
capacity: Optional[pulumi.Input[
|
|
255
|
-
|
|
256
|
-
|
|
683
|
+
capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
684
|
+
custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceCustomTagArgs', 'DatabaseInstanceCustomTagArgsDict']]]]] = None,
|
|
685
|
+
enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
686
|
+
enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
687
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
688
|
+
node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
689
|
+
parent_instance_ref: Optional[pulumi.Input[Union['DatabaseInstanceParentInstanceRefArgs', 'DatabaseInstanceParentInstanceRefArgsDict']]] = None,
|
|
690
|
+
purge_on_delete: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
691
|
+
retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
692
|
+
stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
693
|
+
usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
257
694
|
__props__=None):
|
|
258
695
|
"""
|
|
259
|
-
|
|
696
|
+
[](https://docs.databricks.com/aws/en/release-notes/release-types)
|
|
697
|
+
|
|
698
|
+
Lakebase Database Instances are managed Postgres instances, composed of a primary Postgres compute instance and 0 or more read replica instances.
|
|
260
699
|
|
|
261
700
|
## Example Usage
|
|
262
701
|
|
|
702
|
+
### Basic Example
|
|
703
|
+
|
|
704
|
+
This example creates a simple Database Instance with the specified name and capacity.
|
|
705
|
+
|
|
263
706
|
```python
|
|
264
707
|
import pulumi
|
|
265
708
|
import pulumi_databricks as databricks
|
|
@@ -269,6 +712,61 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
269
712
|
capacity="CU_2")
|
|
270
713
|
```
|
|
271
714
|
|
|
715
|
+
### Example with Readable Secondaries
|
|
716
|
+
|
|
717
|
+
This example creates a Database Instance with readable secondaries (and HA) enabled.
|
|
718
|
+
|
|
719
|
+
```python
|
|
720
|
+
import pulumi
|
|
721
|
+
import pulumi_databricks as databricks
|
|
722
|
+
|
|
723
|
+
this = databricks.DatabaseInstance("this",
|
|
724
|
+
name="my-database-instance",
|
|
725
|
+
capacity="CU_2",
|
|
726
|
+
node_count=2,
|
|
727
|
+
enable_readable_secondaries=True)
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
### Example Child Instance Created From Parent
|
|
731
|
+
|
|
732
|
+
This example creates a child Database Instance from a specified parent Database Instance at the current point in time.
|
|
733
|
+
|
|
734
|
+
```python
|
|
735
|
+
import pulumi
|
|
736
|
+
import pulumi_databricks as databricks
|
|
737
|
+
|
|
738
|
+
child = databricks.DatabaseInstance("child",
|
|
739
|
+
name="my-database-instance",
|
|
740
|
+
capacity="CU_2",
|
|
741
|
+
parent_instance_ref={
|
|
742
|
+
"name": "my-parent-instance",
|
|
743
|
+
})
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
### Example with a usage policy and custom tags
|
|
747
|
+
|
|
748
|
+
This example creates a Database Instance with an associated usage policy and custom tags.
|
|
749
|
+
|
|
750
|
+
```python
|
|
751
|
+
import pulumi
|
|
752
|
+
import pulumi_databricks as databricks
|
|
753
|
+
|
|
754
|
+
this = databricks.DatabaseInstance("this",
|
|
755
|
+
name="my-database-instance",
|
|
756
|
+
capacity="CU_8",
|
|
757
|
+
usage_policy_id="948192fa-a98b-498f-a09b-ecee79d8b983",
|
|
758
|
+
custom_tags=[
|
|
759
|
+
{
|
|
760
|
+
"key": "custom_tag_key1",
|
|
761
|
+
"value": "custom_tag_value1",
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"key": "custom_tag_key2",
|
|
765
|
+
"value": "custom_tag_value2",
|
|
766
|
+
},
|
|
767
|
+
])
|
|
768
|
+
```
|
|
769
|
+
|
|
272
770
|
## Import
|
|
273
771
|
|
|
274
772
|
As of Pulumi v1.5, resources can be imported through configuration.
|
|
@@ -277,7 +775,7 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
277
775
|
|
|
278
776
|
import {
|
|
279
777
|
|
|
280
|
-
id = name
|
|
778
|
+
id = "name"
|
|
281
779
|
|
|
282
780
|
to = databricks_database_instance.this
|
|
283
781
|
|
|
@@ -286,14 +784,28 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
286
784
|
If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
|
|
287
785
|
|
|
288
786
|
```sh
|
|
289
|
-
$ pulumi import databricks:index/databaseInstance:DatabaseInstance
|
|
787
|
+
$ pulumi import databricks:index/databaseInstance:DatabaseInstance this "name"
|
|
290
788
|
```
|
|
291
789
|
|
|
292
790
|
:param str resource_name: The name of the resource.
|
|
293
791
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
294
|
-
:param pulumi.Input[
|
|
295
|
-
:param pulumi.Input[
|
|
296
|
-
:param pulumi.Input[
|
|
792
|
+
:param pulumi.Input[_builtins.str] capacity: The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
793
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceCustomTagArgs', 'DatabaseInstanceCustomTagArgsDict']]]] custom_tags: Custom tags associated with the instance. This field is only included on create and update responses
|
|
794
|
+
:param pulumi.Input[_builtins.bool] enable_pg_native_login: Whether to enable PG native password login on the instance. Defaults to false
|
|
795
|
+
:param pulumi.Input[_builtins.bool] enable_readable_secondaries: Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
796
|
+
:param pulumi.Input[_builtins.str] name: The name of the instance. This is the unique identifier for the instance
|
|
797
|
+
:param pulumi.Input[_builtins.int] node_count: The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
798
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
799
|
+
:param pulumi.Input[Union['DatabaseInstanceParentInstanceRefArgs', 'DatabaseInstanceParentInstanceRefArgsDict']] parent_instance_ref: The ref of the parent instance. This is only available if the instance is
|
|
800
|
+
child instance.
|
|
801
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
802
|
+
Output: Only populated if provided as input to create a child instance
|
|
803
|
+
:param pulumi.Input[_builtins.bool] purge_on_delete: Purge the resource on delete
|
|
804
|
+
:param pulumi.Input[_builtins.int] retention_window_in_days: The retention window for the instance. This is the time window in days
|
|
805
|
+
for which the historical data is retained. The default value is 7 days.
|
|
806
|
+
Valid values are 2 to 35 days
|
|
807
|
+
:param pulumi.Input[_builtins.bool] stopped: Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
808
|
+
:param pulumi.Input[_builtins.str] usage_policy_id: The desired usage policy to associate with the instance
|
|
297
809
|
"""
|
|
298
810
|
...
|
|
299
811
|
@overload
|
|
@@ -302,10 +814,16 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
302
814
|
args: Optional[DatabaseInstanceArgs] = None,
|
|
303
815
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
304
816
|
"""
|
|
305
|
-
|
|
817
|
+
[](https://docs.databricks.com/aws/en/release-notes/release-types)
|
|
818
|
+
|
|
819
|
+
Lakebase Database Instances are managed Postgres instances, composed of a primary Postgres compute instance and 0 or more read replica instances.
|
|
306
820
|
|
|
307
821
|
## Example Usage
|
|
308
822
|
|
|
823
|
+
### Basic Example
|
|
824
|
+
|
|
825
|
+
This example creates a simple Database Instance with the specified name and capacity.
|
|
826
|
+
|
|
309
827
|
```python
|
|
310
828
|
import pulumi
|
|
311
829
|
import pulumi_databricks as databricks
|
|
@@ -315,6 +833,61 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
315
833
|
capacity="CU_2")
|
|
316
834
|
```
|
|
317
835
|
|
|
836
|
+
### Example with Readable Secondaries
|
|
837
|
+
|
|
838
|
+
This example creates a Database Instance with readable secondaries (and HA) enabled.
|
|
839
|
+
|
|
840
|
+
```python
|
|
841
|
+
import pulumi
|
|
842
|
+
import pulumi_databricks as databricks
|
|
843
|
+
|
|
844
|
+
this = databricks.DatabaseInstance("this",
|
|
845
|
+
name="my-database-instance",
|
|
846
|
+
capacity="CU_2",
|
|
847
|
+
node_count=2,
|
|
848
|
+
enable_readable_secondaries=True)
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
### Example Child Instance Created From Parent
|
|
852
|
+
|
|
853
|
+
This example creates a child Database Instance from a specified parent Database Instance at the current point in time.
|
|
854
|
+
|
|
855
|
+
```python
|
|
856
|
+
import pulumi
|
|
857
|
+
import pulumi_databricks as databricks
|
|
858
|
+
|
|
859
|
+
child = databricks.DatabaseInstance("child",
|
|
860
|
+
name="my-database-instance",
|
|
861
|
+
capacity="CU_2",
|
|
862
|
+
parent_instance_ref={
|
|
863
|
+
"name": "my-parent-instance",
|
|
864
|
+
})
|
|
865
|
+
```
|
|
866
|
+
|
|
867
|
+
### Example with a usage policy and custom tags
|
|
868
|
+
|
|
869
|
+
This example creates a Database Instance with an associated usage policy and custom tags.
|
|
870
|
+
|
|
871
|
+
```python
|
|
872
|
+
import pulumi
|
|
873
|
+
import pulumi_databricks as databricks
|
|
874
|
+
|
|
875
|
+
this = databricks.DatabaseInstance("this",
|
|
876
|
+
name="my-database-instance",
|
|
877
|
+
capacity="CU_8",
|
|
878
|
+
usage_policy_id="948192fa-a98b-498f-a09b-ecee79d8b983",
|
|
879
|
+
custom_tags=[
|
|
880
|
+
{
|
|
881
|
+
"key": "custom_tag_key1",
|
|
882
|
+
"value": "custom_tag_value1",
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"key": "custom_tag_key2",
|
|
886
|
+
"value": "custom_tag_value2",
|
|
887
|
+
},
|
|
888
|
+
])
|
|
889
|
+
```
|
|
890
|
+
|
|
318
891
|
## Import
|
|
319
892
|
|
|
320
893
|
As of Pulumi v1.5, resources can be imported through configuration.
|
|
@@ -323,7 +896,7 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
323
896
|
|
|
324
897
|
import {
|
|
325
898
|
|
|
326
|
-
id = name
|
|
899
|
+
id = "name"
|
|
327
900
|
|
|
328
901
|
to = databricks_database_instance.this
|
|
329
902
|
|
|
@@ -332,7 +905,7 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
332
905
|
If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
|
|
333
906
|
|
|
334
907
|
```sh
|
|
335
|
-
$ pulumi import databricks:index/databaseInstance:DatabaseInstance
|
|
908
|
+
$ pulumi import databricks:index/databaseInstance:DatabaseInstance this "name"
|
|
336
909
|
```
|
|
337
910
|
|
|
338
911
|
:param str resource_name: The name of the resource.
|
|
@@ -350,9 +923,17 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
350
923
|
def _internal_init(__self__,
|
|
351
924
|
resource_name: str,
|
|
352
925
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
353
|
-
capacity: Optional[pulumi.Input[
|
|
354
|
-
|
|
355
|
-
|
|
926
|
+
capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
927
|
+
custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceCustomTagArgs', 'DatabaseInstanceCustomTagArgsDict']]]]] = None,
|
|
928
|
+
enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
929
|
+
enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
930
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
931
|
+
node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
932
|
+
parent_instance_ref: Optional[pulumi.Input[Union['DatabaseInstanceParentInstanceRefArgs', 'DatabaseInstanceParentInstanceRefArgsDict']]] = None,
|
|
933
|
+
purge_on_delete: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
934
|
+
retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
935
|
+
stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
936
|
+
usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
356
937
|
__props__=None):
|
|
357
938
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
358
939
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -363,12 +944,29 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
363
944
|
__props__ = DatabaseInstanceArgs.__new__(DatabaseInstanceArgs)
|
|
364
945
|
|
|
365
946
|
__props__.__dict__["capacity"] = capacity
|
|
947
|
+
__props__.__dict__["custom_tags"] = custom_tags
|
|
948
|
+
__props__.__dict__["enable_pg_native_login"] = enable_pg_native_login
|
|
949
|
+
__props__.__dict__["enable_readable_secondaries"] = enable_readable_secondaries
|
|
366
950
|
__props__.__dict__["name"] = name
|
|
951
|
+
__props__.__dict__["node_count"] = node_count
|
|
952
|
+
__props__.__dict__["parent_instance_ref"] = parent_instance_ref
|
|
953
|
+
__props__.__dict__["purge_on_delete"] = purge_on_delete
|
|
954
|
+
__props__.__dict__["retention_window_in_days"] = retention_window_in_days
|
|
367
955
|
__props__.__dict__["stopped"] = stopped
|
|
956
|
+
__props__.__dict__["usage_policy_id"] = usage_policy_id
|
|
957
|
+
__props__.__dict__["child_instance_refs"] = None
|
|
368
958
|
__props__.__dict__["creation_time"] = None
|
|
369
959
|
__props__.__dict__["creator"] = None
|
|
960
|
+
__props__.__dict__["effective_capacity"] = None
|
|
961
|
+
__props__.__dict__["effective_custom_tags"] = None
|
|
962
|
+
__props__.__dict__["effective_enable_pg_native_login"] = None
|
|
963
|
+
__props__.__dict__["effective_enable_readable_secondaries"] = None
|
|
964
|
+
__props__.__dict__["effective_node_count"] = None
|
|
965
|
+
__props__.__dict__["effective_retention_window_in_days"] = None
|
|
370
966
|
__props__.__dict__["effective_stopped"] = None
|
|
967
|
+
__props__.__dict__["effective_usage_policy_id"] = None
|
|
371
968
|
__props__.__dict__["pg_version"] = None
|
|
969
|
+
__props__.__dict__["read_only_dns"] = None
|
|
372
970
|
__props__.__dict__["read_write_dns"] = None
|
|
373
971
|
__props__.__dict__["state"] = None
|
|
374
972
|
__props__.__dict__["uid"] = None
|
|
@@ -382,16 +980,33 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
382
980
|
def get(resource_name: str,
|
|
383
981
|
id: pulumi.Input[str],
|
|
384
982
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
385
|
-
capacity: Optional[pulumi.Input[
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
983
|
+
capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
984
|
+
child_instance_refs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceChildInstanceRefArgs', 'DatabaseInstanceChildInstanceRefArgsDict']]]]] = None,
|
|
985
|
+
creation_time: Optional[pulumi.Input[_builtins.str]] = None,
|
|
986
|
+
creator: Optional[pulumi.Input[_builtins.str]] = None,
|
|
987
|
+
custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceCustomTagArgs', 'DatabaseInstanceCustomTagArgsDict']]]]] = None,
|
|
988
|
+
effective_capacity: Optional[pulumi.Input[_builtins.str]] = None,
|
|
989
|
+
effective_custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceEffectiveCustomTagArgs', 'DatabaseInstanceEffectiveCustomTagArgsDict']]]]] = None,
|
|
990
|
+
effective_enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
991
|
+
effective_enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
992
|
+
effective_node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
993
|
+
effective_retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
994
|
+
effective_stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
995
|
+
effective_usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
996
|
+
enable_pg_native_login: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
997
|
+
enable_readable_secondaries: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
998
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
999
|
+
node_count: Optional[pulumi.Input[_builtins.int]] = None,
|
|
1000
|
+
parent_instance_ref: Optional[pulumi.Input[Union['DatabaseInstanceParentInstanceRefArgs', 'DatabaseInstanceParentInstanceRefArgsDict']]] = None,
|
|
1001
|
+
pg_version: Optional[pulumi.Input[_builtins.str]] = None,
|
|
1002
|
+
purge_on_delete: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
1003
|
+
read_only_dns: Optional[pulumi.Input[_builtins.str]] = None,
|
|
1004
|
+
read_write_dns: Optional[pulumi.Input[_builtins.str]] = None,
|
|
1005
|
+
retention_window_in_days: Optional[pulumi.Input[_builtins.int]] = None,
|
|
1006
|
+
state: Optional[pulumi.Input[_builtins.str]] = None,
|
|
1007
|
+
stopped: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
1008
|
+
uid: Optional[pulumi.Input[_builtins.str]] = None,
|
|
1009
|
+
usage_policy_id: Optional[pulumi.Input[_builtins.str]] = None) -> 'DatabaseInstance':
|
|
395
1010
|
"""
|
|
396
1011
|
Get an existing DatabaseInstance resource's state with the given name, id, and optional extra
|
|
397
1012
|
properties used to qualify the lookup.
|
|
@@ -399,114 +1014,300 @@ class DatabaseInstance(pulumi.CustomResource):
|
|
|
399
1014
|
:param str resource_name: The unique name of the resulting resource.
|
|
400
1015
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
401
1016
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
402
|
-
:param pulumi.Input[
|
|
403
|
-
:param pulumi.Input[
|
|
404
|
-
|
|
405
|
-
:param pulumi.Input[
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
:param pulumi.Input[
|
|
409
|
-
:param pulumi.Input[
|
|
410
|
-
:param pulumi.Input[
|
|
411
|
-
:param pulumi.Input[
|
|
412
|
-
:param pulumi.Input[
|
|
413
|
-
|
|
1017
|
+
:param pulumi.Input[_builtins.str] capacity: The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
1018
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceChildInstanceRefArgs', 'DatabaseInstanceChildInstanceRefArgsDict']]]] child_instance_refs: (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is
|
|
1019
|
+
parent instance
|
|
1020
|
+
:param pulumi.Input[_builtins.str] creation_time: (string) - The timestamp when the instance was created
|
|
1021
|
+
:param pulumi.Input[_builtins.str] creator: (string) - The email of the creator of the instance
|
|
1022
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceCustomTagArgs', 'DatabaseInstanceCustomTagArgsDict']]]] custom_tags: Custom tags associated with the instance. This field is only included on create and update responses
|
|
1023
|
+
:param pulumi.Input[_builtins.str] effective_capacity: (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
|
|
1024
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['DatabaseInstanceEffectiveCustomTagArgs', 'DatabaseInstanceEffectiveCustomTagArgsDict']]]] effective_custom_tags: (list of CustomTag) - The recorded custom tags associated with the instance
|
|
1025
|
+
:param pulumi.Input[_builtins.bool] effective_enable_pg_native_login: (boolean) - Whether the instance has PG native password login enabled
|
|
1026
|
+
:param pulumi.Input[_builtins.bool] effective_enable_readable_secondaries: (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
|
|
1027
|
+
:param pulumi.Input[_builtins.int] effective_node_count: (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
1028
|
+
1 primary and 0 secondaries
|
|
1029
|
+
:param pulumi.Input[_builtins.int] effective_retention_window_in_days: (integer) - The retention window for the instance. This is the time window in days
|
|
1030
|
+
for which the historical data is retained
|
|
1031
|
+
:param pulumi.Input[_builtins.bool] effective_stopped: (boolean) - Whether the instance is stopped
|
|
1032
|
+
:param pulumi.Input[_builtins.str] effective_usage_policy_id: (string) - The policy that is applied to the instance
|
|
1033
|
+
:param pulumi.Input[_builtins.bool] enable_pg_native_login: Whether to enable PG native password login on the instance. Defaults to false
|
|
1034
|
+
:param pulumi.Input[_builtins.bool] enable_readable_secondaries: Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
1035
|
+
:param pulumi.Input[_builtins.str] name: The name of the instance. This is the unique identifier for the instance
|
|
1036
|
+
:param pulumi.Input[_builtins.int] node_count: The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
1037
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
1038
|
+
:param pulumi.Input[Union['DatabaseInstanceParentInstanceRefArgs', 'DatabaseInstanceParentInstanceRefArgsDict']] parent_instance_ref: The ref of the parent instance. This is only available if the instance is
|
|
1039
|
+
child instance.
|
|
1040
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
1041
|
+
Output: Only populated if provided as input to create a child instance
|
|
1042
|
+
:param pulumi.Input[_builtins.str] pg_version: (string) - The version of Postgres running on the instance
|
|
1043
|
+
:param pulumi.Input[_builtins.bool] purge_on_delete: Purge the resource on delete
|
|
1044
|
+
:param pulumi.Input[_builtins.str] read_only_dns: (string) - The DNS endpoint to connect to the instance for read only access. This is only available if
|
|
1045
|
+
enable_readable_secondaries is true
|
|
1046
|
+
:param pulumi.Input[_builtins.str] read_write_dns: (string) - The DNS endpoint to connect to the instance for read+write access
|
|
1047
|
+
:param pulumi.Input[_builtins.int] retention_window_in_days: The retention window for the instance. This is the time window in days
|
|
1048
|
+
for which the historical data is retained. The default value is 7 days.
|
|
1049
|
+
Valid values are 2 to 35 days
|
|
1050
|
+
:param pulumi.Input[_builtins.str] state: (string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
|
|
1051
|
+
:param pulumi.Input[_builtins.bool] stopped: Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
1052
|
+
:param pulumi.Input[_builtins.str] uid: (string) - Id of the ref database instance
|
|
1053
|
+
:param pulumi.Input[_builtins.str] usage_policy_id: The desired usage policy to associate with the instance
|
|
414
1054
|
"""
|
|
415
1055
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
416
1056
|
|
|
417
1057
|
__props__ = _DatabaseInstanceState.__new__(_DatabaseInstanceState)
|
|
418
1058
|
|
|
419
1059
|
__props__.__dict__["capacity"] = capacity
|
|
1060
|
+
__props__.__dict__["child_instance_refs"] = child_instance_refs
|
|
420
1061
|
__props__.__dict__["creation_time"] = creation_time
|
|
421
1062
|
__props__.__dict__["creator"] = creator
|
|
1063
|
+
__props__.__dict__["custom_tags"] = custom_tags
|
|
1064
|
+
__props__.__dict__["effective_capacity"] = effective_capacity
|
|
1065
|
+
__props__.__dict__["effective_custom_tags"] = effective_custom_tags
|
|
1066
|
+
__props__.__dict__["effective_enable_pg_native_login"] = effective_enable_pg_native_login
|
|
1067
|
+
__props__.__dict__["effective_enable_readable_secondaries"] = effective_enable_readable_secondaries
|
|
1068
|
+
__props__.__dict__["effective_node_count"] = effective_node_count
|
|
1069
|
+
__props__.__dict__["effective_retention_window_in_days"] = effective_retention_window_in_days
|
|
422
1070
|
__props__.__dict__["effective_stopped"] = effective_stopped
|
|
1071
|
+
__props__.__dict__["effective_usage_policy_id"] = effective_usage_policy_id
|
|
1072
|
+
__props__.__dict__["enable_pg_native_login"] = enable_pg_native_login
|
|
1073
|
+
__props__.__dict__["enable_readable_secondaries"] = enable_readable_secondaries
|
|
423
1074
|
__props__.__dict__["name"] = name
|
|
1075
|
+
__props__.__dict__["node_count"] = node_count
|
|
1076
|
+
__props__.__dict__["parent_instance_ref"] = parent_instance_ref
|
|
424
1077
|
__props__.__dict__["pg_version"] = pg_version
|
|
1078
|
+
__props__.__dict__["purge_on_delete"] = purge_on_delete
|
|
1079
|
+
__props__.__dict__["read_only_dns"] = read_only_dns
|
|
425
1080
|
__props__.__dict__["read_write_dns"] = read_write_dns
|
|
1081
|
+
__props__.__dict__["retention_window_in_days"] = retention_window_in_days
|
|
426
1082
|
__props__.__dict__["state"] = state
|
|
427
1083
|
__props__.__dict__["stopped"] = stopped
|
|
428
1084
|
__props__.__dict__["uid"] = uid
|
|
1085
|
+
__props__.__dict__["usage_policy_id"] = usage_policy_id
|
|
429
1086
|
return DatabaseInstance(resource_name, opts=opts, __props__=__props__)
|
|
430
1087
|
|
|
431
|
-
@property
|
|
1088
|
+
@_builtins.property
|
|
432
1089
|
@pulumi.getter
|
|
433
|
-
def capacity(self) -> pulumi.Output[Optional[
|
|
1090
|
+
def capacity(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
434
1091
|
"""
|
|
435
1092
|
The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
|
|
436
1093
|
"""
|
|
437
1094
|
return pulumi.get(self, "capacity")
|
|
438
1095
|
|
|
439
|
-
@property
|
|
1096
|
+
@_builtins.property
|
|
1097
|
+
@pulumi.getter(name="childInstanceRefs")
|
|
1098
|
+
def child_instance_refs(self) -> pulumi.Output[Sequence['outputs.DatabaseInstanceChildInstanceRef']]:
|
|
1099
|
+
"""
|
|
1100
|
+
(list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is
|
|
1101
|
+
parent instance
|
|
1102
|
+
"""
|
|
1103
|
+
return pulumi.get(self, "child_instance_refs")
|
|
1104
|
+
|
|
1105
|
+
@_builtins.property
|
|
440
1106
|
@pulumi.getter(name="creationTime")
|
|
441
|
-
def creation_time(self) -> pulumi.Output[
|
|
1107
|
+
def creation_time(self) -> pulumi.Output[_builtins.str]:
|
|
442
1108
|
"""
|
|
443
1109
|
(string) - The timestamp when the instance was created
|
|
444
1110
|
"""
|
|
445
1111
|
return pulumi.get(self, "creation_time")
|
|
446
1112
|
|
|
447
|
-
@property
|
|
1113
|
+
@_builtins.property
|
|
448
1114
|
@pulumi.getter
|
|
449
|
-
def creator(self) -> pulumi.Output[
|
|
1115
|
+
def creator(self) -> pulumi.Output[_builtins.str]:
|
|
450
1116
|
"""
|
|
451
1117
|
(string) - The email of the creator of the instance
|
|
452
1118
|
"""
|
|
453
1119
|
return pulumi.get(self, "creator")
|
|
454
1120
|
|
|
455
|
-
@property
|
|
1121
|
+
@_builtins.property
|
|
1122
|
+
@pulumi.getter(name="customTags")
|
|
1123
|
+
def custom_tags(self) -> pulumi.Output[Sequence['outputs.DatabaseInstanceCustomTag']]:
|
|
1124
|
+
"""
|
|
1125
|
+
Custom tags associated with the instance. This field is only included on create and update responses
|
|
1126
|
+
"""
|
|
1127
|
+
return pulumi.get(self, "custom_tags")
|
|
1128
|
+
|
|
1129
|
+
@_builtins.property
|
|
1130
|
+
@pulumi.getter(name="effectiveCapacity")
|
|
1131
|
+
def effective_capacity(self) -> pulumi.Output[_builtins.str]:
|
|
1132
|
+
"""
|
|
1133
|
+
(string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
|
|
1134
|
+
"""
|
|
1135
|
+
return pulumi.get(self, "effective_capacity")
|
|
1136
|
+
|
|
1137
|
+
@_builtins.property
|
|
1138
|
+
@pulumi.getter(name="effectiveCustomTags")
|
|
1139
|
+
def effective_custom_tags(self) -> pulumi.Output[Sequence['outputs.DatabaseInstanceEffectiveCustomTag']]:
|
|
1140
|
+
"""
|
|
1141
|
+
(list of CustomTag) - The recorded custom tags associated with the instance
|
|
1142
|
+
"""
|
|
1143
|
+
return pulumi.get(self, "effective_custom_tags")
|
|
1144
|
+
|
|
1145
|
+
@_builtins.property
|
|
1146
|
+
@pulumi.getter(name="effectiveEnablePgNativeLogin")
|
|
1147
|
+
def effective_enable_pg_native_login(self) -> pulumi.Output[_builtins.bool]:
|
|
1148
|
+
"""
|
|
1149
|
+
(boolean) - Whether the instance has PG native password login enabled
|
|
1150
|
+
"""
|
|
1151
|
+
return pulumi.get(self, "effective_enable_pg_native_login")
|
|
1152
|
+
|
|
1153
|
+
@_builtins.property
|
|
1154
|
+
@pulumi.getter(name="effectiveEnableReadableSecondaries")
|
|
1155
|
+
def effective_enable_readable_secondaries(self) -> pulumi.Output[_builtins.bool]:
|
|
1156
|
+
"""
|
|
1157
|
+
(boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
|
|
1158
|
+
"""
|
|
1159
|
+
return pulumi.get(self, "effective_enable_readable_secondaries")
|
|
1160
|
+
|
|
1161
|
+
@_builtins.property
|
|
1162
|
+
@pulumi.getter(name="effectiveNodeCount")
|
|
1163
|
+
def effective_node_count(self) -> pulumi.Output[_builtins.int]:
|
|
1164
|
+
"""
|
|
1165
|
+
(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
1166
|
+
1 primary and 0 secondaries
|
|
1167
|
+
"""
|
|
1168
|
+
return pulumi.get(self, "effective_node_count")
|
|
1169
|
+
|
|
1170
|
+
@_builtins.property
|
|
1171
|
+
@pulumi.getter(name="effectiveRetentionWindowInDays")
|
|
1172
|
+
def effective_retention_window_in_days(self) -> pulumi.Output[_builtins.int]:
|
|
1173
|
+
"""
|
|
1174
|
+
(integer) - The retention window for the instance. This is the time window in days
|
|
1175
|
+
for which the historical data is retained
|
|
1176
|
+
"""
|
|
1177
|
+
return pulumi.get(self, "effective_retention_window_in_days")
|
|
1178
|
+
|
|
1179
|
+
@_builtins.property
|
|
456
1180
|
@pulumi.getter(name="effectiveStopped")
|
|
457
|
-
def effective_stopped(self) -> pulumi.Output[
|
|
1181
|
+
def effective_stopped(self) -> pulumi.Output[_builtins.bool]:
|
|
458
1182
|
"""
|
|
459
|
-
(boolean) -
|
|
460
|
-
`stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.
|
|
461
|
-
`effective_stopped` on the other hand will always bet set in all response messages (Create/Update/Get/List)
|
|
1183
|
+
(boolean) - Whether the instance is stopped
|
|
462
1184
|
"""
|
|
463
1185
|
return pulumi.get(self, "effective_stopped")
|
|
464
1186
|
|
|
465
|
-
@property
|
|
1187
|
+
@_builtins.property
|
|
1188
|
+
@pulumi.getter(name="effectiveUsagePolicyId")
|
|
1189
|
+
def effective_usage_policy_id(self) -> pulumi.Output[_builtins.str]:
|
|
1190
|
+
"""
|
|
1191
|
+
(string) - The policy that is applied to the instance
|
|
1192
|
+
"""
|
|
1193
|
+
return pulumi.get(self, "effective_usage_policy_id")
|
|
1194
|
+
|
|
1195
|
+
@_builtins.property
|
|
1196
|
+
@pulumi.getter(name="enablePgNativeLogin")
|
|
1197
|
+
def enable_pg_native_login(self) -> pulumi.Output[_builtins.bool]:
|
|
1198
|
+
"""
|
|
1199
|
+
Whether to enable PG native password login on the instance. Defaults to false
|
|
1200
|
+
"""
|
|
1201
|
+
return pulumi.get(self, "enable_pg_native_login")
|
|
1202
|
+
|
|
1203
|
+
@_builtins.property
|
|
1204
|
+
@pulumi.getter(name="enableReadableSecondaries")
|
|
1205
|
+
def enable_readable_secondaries(self) -> pulumi.Output[_builtins.bool]:
|
|
1206
|
+
"""
|
|
1207
|
+
Whether to enable secondaries to serve read-only traffic. Defaults to false
|
|
1208
|
+
"""
|
|
1209
|
+
return pulumi.get(self, "enable_readable_secondaries")
|
|
1210
|
+
|
|
1211
|
+
@_builtins.property
|
|
466
1212
|
@pulumi.getter
|
|
467
|
-
def name(self) -> pulumi.Output[
|
|
1213
|
+
def name(self) -> pulumi.Output[_builtins.str]:
|
|
468
1214
|
"""
|
|
469
1215
|
The name of the instance. This is the unique identifier for the instance
|
|
470
1216
|
"""
|
|
471
1217
|
return pulumi.get(self, "name")
|
|
472
1218
|
|
|
473
|
-
@property
|
|
1219
|
+
@_builtins.property
|
|
1220
|
+
@pulumi.getter(name="nodeCount")
|
|
1221
|
+
def node_count(self) -> pulumi.Output[_builtins.int]:
|
|
1222
|
+
"""
|
|
1223
|
+
The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to
|
|
1224
|
+
1 primary and 0 secondaries. This field is input only, see effective_node_count for the output
|
|
1225
|
+
"""
|
|
1226
|
+
return pulumi.get(self, "node_count")
|
|
1227
|
+
|
|
1228
|
+
@_builtins.property
|
|
1229
|
+
@pulumi.getter(name="parentInstanceRef")
|
|
1230
|
+
def parent_instance_ref(self) -> pulumi.Output[Optional['outputs.DatabaseInstanceParentInstanceRef']]:
|
|
1231
|
+
"""
|
|
1232
|
+
The ref of the parent instance. This is only available if the instance is
|
|
1233
|
+
child instance.
|
|
1234
|
+
Input: For specifying the parent instance to create a child instance. Optional.
|
|
1235
|
+
Output: Only populated if provided as input to create a child instance
|
|
1236
|
+
"""
|
|
1237
|
+
return pulumi.get(self, "parent_instance_ref")
|
|
1238
|
+
|
|
1239
|
+
@_builtins.property
|
|
474
1240
|
@pulumi.getter(name="pgVersion")
|
|
475
|
-
def pg_version(self) -> pulumi.Output[
|
|
1241
|
+
def pg_version(self) -> pulumi.Output[_builtins.str]:
|
|
476
1242
|
"""
|
|
477
1243
|
(string) - The version of Postgres running on the instance
|
|
478
1244
|
"""
|
|
479
1245
|
return pulumi.get(self, "pg_version")
|
|
480
1246
|
|
|
481
|
-
@property
|
|
1247
|
+
@_builtins.property
|
|
1248
|
+
@pulumi.getter(name="purgeOnDelete")
|
|
1249
|
+
def purge_on_delete(self) -> pulumi.Output[Optional[_builtins.bool]]:
|
|
1250
|
+
"""
|
|
1251
|
+
Purge the resource on delete
|
|
1252
|
+
"""
|
|
1253
|
+
return pulumi.get(self, "purge_on_delete")
|
|
1254
|
+
|
|
1255
|
+
@_builtins.property
|
|
1256
|
+
@pulumi.getter(name="readOnlyDns")
|
|
1257
|
+
def read_only_dns(self) -> pulumi.Output[_builtins.str]:
|
|
1258
|
+
"""
|
|
1259
|
+
(string) - The DNS endpoint to connect to the instance for read only access. This is only available if
|
|
1260
|
+
enable_readable_secondaries is true
|
|
1261
|
+
"""
|
|
1262
|
+
return pulumi.get(self, "read_only_dns")
|
|
1263
|
+
|
|
1264
|
+
@_builtins.property
|
|
482
1265
|
@pulumi.getter(name="readWriteDns")
|
|
483
|
-
def read_write_dns(self) -> pulumi.Output[
|
|
1266
|
+
def read_write_dns(self) -> pulumi.Output[_builtins.str]:
|
|
484
1267
|
"""
|
|
485
1268
|
(string) - The DNS endpoint to connect to the instance for read+write access
|
|
486
1269
|
"""
|
|
487
1270
|
return pulumi.get(self, "read_write_dns")
|
|
488
1271
|
|
|
489
|
-
@property
|
|
1272
|
+
@_builtins.property
|
|
1273
|
+
@pulumi.getter(name="retentionWindowInDays")
|
|
1274
|
+
def retention_window_in_days(self) -> pulumi.Output[_builtins.int]:
|
|
1275
|
+
"""
|
|
1276
|
+
The retention window for the instance. This is the time window in days
|
|
1277
|
+
for which the historical data is retained. The default value is 7 days.
|
|
1278
|
+
Valid values are 2 to 35 days
|
|
1279
|
+
"""
|
|
1280
|
+
return pulumi.get(self, "retention_window_in_days")
|
|
1281
|
+
|
|
1282
|
+
@_builtins.property
|
|
490
1283
|
@pulumi.getter
|
|
491
|
-
def state(self) -> pulumi.Output[
|
|
1284
|
+
def state(self) -> pulumi.Output[_builtins.str]:
|
|
492
1285
|
"""
|
|
493
1286
|
(string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`
|
|
494
1287
|
"""
|
|
495
1288
|
return pulumi.get(self, "state")
|
|
496
1289
|
|
|
497
|
-
@property
|
|
1290
|
+
@_builtins.property
|
|
498
1291
|
@pulumi.getter
|
|
499
|
-
def stopped(self) -> pulumi.Output[
|
|
1292
|
+
def stopped(self) -> pulumi.Output[_builtins.bool]:
|
|
500
1293
|
"""
|
|
501
|
-
Whether the instance
|
|
1294
|
+
Whether to stop the instance. An input only param, see effective_stopped for the output
|
|
502
1295
|
"""
|
|
503
1296
|
return pulumi.get(self, "stopped")
|
|
504
1297
|
|
|
505
|
-
@property
|
|
1298
|
+
@_builtins.property
|
|
506
1299
|
@pulumi.getter
|
|
507
|
-
def uid(self) -> pulumi.Output[
|
|
1300
|
+
def uid(self) -> pulumi.Output[_builtins.str]:
|
|
508
1301
|
"""
|
|
509
|
-
(string) -
|
|
1302
|
+
(string) - Id of the ref database instance
|
|
510
1303
|
"""
|
|
511
1304
|
return pulumi.get(self, "uid")
|
|
512
1305
|
|
|
1306
|
+
@_builtins.property
|
|
1307
|
+
@pulumi.getter(name="usagePolicyId")
|
|
1308
|
+
def usage_policy_id(self) -> pulumi.Output[_builtins.str]:
|
|
1309
|
+
"""
|
|
1310
|
+
The desired usage policy to associate with the instance
|
|
1311
|
+
"""
|
|
1312
|
+
return pulumi.get(self, "usage_policy_id")
|
|
1313
|
+
|