SupabaseProject
- Implements: ISupabaseProject
This class encapsulates and extends the ROS resource type ALIYUN::GPDB::SupabaseProjectThe , which resource creates a Supabase project.
Initializers
import ros_cdk_gpdb
ros_cdk_gpdb.SupabaseProject(
scope: Construct,
id: str,
account_password: typing.Union[str, IResolvable],
project_name: typing.Union[str, IResolvable],
project_spec: typing.Union[str, IResolvable],
security_ip_list: typing.Union[str, IResolvable],
vpc_id: typing.Union[str, IResolvable],
v_switch_id: typing.Union[str, IResolvable],
zone_id: typing.Union[str, IResolvable],
database_ip_list: typing.Union[str, IResolvable] = None,
disk_performance_level: typing.Union[str, IResolvable] = None,
pay_type: typing.Union[str, IResolvable] = None,
period: typing.Union[str, IResolvable] = None,
storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
used_time: typing.Union[typing.Union[int, float], IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
account_password | typing.Union[str, ros_cdk_core.IResolvable] | Property accountPassword: The password for the initial account. |
project_name | typing.Union[str, ros_cdk_core.IResolvable] | Property projectName: Project name.The naming rules are as follows: The length is 1~128 characters. Only English letters, numbers, dash (-) and underscore (). Must start with English letters or underscores (). |
project_spec | typing.Union[str, ros_cdk_core.IResolvable] | Property projectSpec: Supabase instance specification, default is 1C1G. |
security_ip_list | typing.Union[str, ros_cdk_core.IResolvable] | Property securityIpList: IP whitelist. |
vpc_id | typing.Union[str, ros_cdk_core.IResolvable] | Property vpcId: VPC ID. |
v_switch_id | typing.Union[str, ros_cdk_core.IResolvable] | Property vSwitchId: vSwitch ID. |
zone_id | typing.Union[str, ros_cdk_core.IResolvable] | Property zoneId: Availability Zone ID. |
database_ip_list | typing.Union[str, ros_cdk_core.IResolvable] | Property databaseIpList: Database IP list. |
disk_performance_level | typing.Union[str, ros_cdk_core.IResolvable] | Property diskPerformanceLevel: Cloud disk PL level, default PL0. |
pay_type | typing.Union[str, ros_cdk_core.IResolvable] | Property payType: The payment type. |
period | typing.Union[str, ros_cdk_core.IResolvable] | Property period: The unit of the subscription duration. |
storage_size | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property storageSize: Storage space size, unit GB, default 1GB. |
used_time | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property usedTime: The subscription duration. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
account_passwordRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accountPassword: The password for the initial account.
It consists of three or more types of capital letters, lowercase letters, numbers, and special characters. Supported special characters: !@#$%^&*()_+-= The length is 8~32 characters.
project_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectName: Project name.The naming rules are as follows: The length is 1~128 characters. Only English letters, numbers, dash (-) and underscore (). Must start with English letters or underscores ().
project_specRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectSpec: Supabase instance specification, default is 1C1G.
security_ip_listRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property securityIpList: IP whitelist.
127.0.0.1 means that any external IP access is prohibited. You can call the ModifySecurityIps interface to modify the IP whitelist after the instance is created.
vpc_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: VPC ID.
illustrate You can call the DescribeRdsVpcs interface to view the available VPC IDs. This parameter must be passed in.
v_switch_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: vSwitch ID.
illustrate vSwitchId is required. The Availability Zone where the vSwitch is located must be consistent with the ZoneId.
zone_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property zoneId: Availability Zone ID.
Description You can call the DescribeRegions interface to view the available Availability Zone ID.
database_ip_listOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property databaseIpList: Database IP list.
disk_performance_levelOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property diskPerformanceLevel: Cloud disk PL level, default PL0.
Selectable value: PL0 PL1
pay_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property payType: The payment type.
periodOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property period: The unit of the subscription duration.
Valid values:
- Month
- Year
This parameter is required if you use the subscription billing method.
storage_sizeOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property storageSize: Storage space size, unit GB, default 1GB.
used_timeOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property usedTime: The subscription duration.
Valid values:
- If Period is set to Month, the valid values are 1 to 11.
- If Period is set to Year, the valid values are 1 to 3.
This parameter is required if you use the subscription billing method.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_gpdb
ros_cdk_gpdb.SupabaseProject.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_api_keys | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ApiKeys: API keys. |
attr_eni | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Eni: Network interface. |
attr_private_connect_url | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PrivateConnectUrl: Private connection URL. |
attr_project_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProjectId: Supabase instance ID. |
attr_public_connect_url | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PublicConnectUrl: Public connection URL. |
props | SupabaseProjectProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: ros_cdk_core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_api_keysRequired
attr_api_keys: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ApiKeys: API keys.
attr_eniRequired
attr_eni: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Eni: Network interface.
attr_private_connect_urlRequired
attr_private_connect_url: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PrivateConnectUrl: Private connection URL.
attr_project_idRequired
attr_project_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProjectId: Supabase instance ID.
attr_public_connect_urlRequired
attr_public_connect_url: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PublicConnectUrl: Public connection URL.
propsRequired
props: SupabaseProjectProps
- Type: SupabaseProjectProps