PostgresExtensions
- Implements: IPostgresExtensions
This class encapsulates and extends the ROS resource type ALIYUN::RDS::PostgresExtensions.
Initializers
import ros_cdk_rds
ros_cdk_rds.PostgresExtensions(
scope: Construct,
id: str,
account_name: typing.Union[str, IResolvable],
db_instance_id: typing.Union[str, IResolvable],
db_name: typing.Union[str, IResolvable],
extensions: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
risk_confirmed: typing.Union[bool, IResolvable] = None,
source_database: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
account_name | typing.Union[str, ros_cdk_core.IResolvable] | Property accountName: The account of the user who owns the extension. |
db_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property dbInstanceId: The instance ID. |
db_name | typing.Union[str, ros_cdk_core.IResolvable] | Property dbName: The database name. |
extensions | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property extensions: The extensions that you want to install. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group. |
risk_confirmed | typing.Union[bool, ros_cdk_core.IResolvable] | Property riskConfirmed: The risk description that you need to confirm. |
source_database | typing.Union[str, ros_cdk_core.IResolvable] | Property sourceDatabase: The source database from which you want to synchronize the extension to the destination database. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
account_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accountName: The account of the user who owns the extension.
Only privileged accounts are supported.
db_instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstanceId: The instance ID.
You can call the DescribeDBInstances operation to query the instance ID.
db_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbName: The database name.
You can call the DescribeDatabases operation to query the database name.
extensionsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property extensions: The extensions that you want to install.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group.
risk_confirmedOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property riskConfirmed: The risk description that you need to confirm.
If your instance runs an outdated minor engine version, installing specific extensions on the instance poses security risks. Proceed with the installation only after you acknowledge these risks. Valid values: true false Note For more information about the risks, see Limits on extension creation for ApsaraDB RDS for PostgreSQL instances.
source_databaseOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceDatabase: The source database from which you want to synchronize the extension to the destination database.
If you do not specify the Extensions parameter, you must specify this parameter.
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_rds
ros_cdk_rds.PostgresExtensions.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_installed_extension_names | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstalledExtensionNames: Extension names installed via ROS. |
props | PostgresExtensionsProps | 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_installed_extension_namesRequired
attr_installed_extension_names: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstalledExtensionNames: Extension names installed via ROS.
propsRequired
props: PostgresExtensionsProps
- Type: PostgresExtensionsProps