Skip to content

RdsExternalStore

This class encapsulates and extends the ROS resource type ALIYUN::SLS::RdsExternalStore.

Initializers

import ros_cdk_sls
ros_cdk_sls.RdsExternalStore(
  scope: Construct,
  id: str,
  db: typing.Union[str, IResolvable],
  external_store_name: typing.Union[str, IResolvable],
  host: typing.Union[str, IResolvable],
  password: typing.Union[str, IResolvable],
  port: typing.Union[typing.Union[int, float], IResolvable],
  project: typing.Union[str, IResolvable],
  region: typing.Union[str, IResolvable],
  store_type: typing.Union[str, IResolvable],
  table: typing.Union[str, IResolvable],
  username: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  instance_id: 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.
db typing.Union[str, ros_cdk_core.IResolvable] Property db: The name of the database in the ApsaraDB RDS for MySQL instance.
external_store_name typing.Union[str, ros_cdk_core.IResolvable] Property externalStoreName: The name of the external store.
host typing.Union[str, ros_cdk_core.IResolvable] Property host: The internal or public endpoint of the ApsaraDB RDS for MySQL instance.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password that is used to log on to the ApsaraDB RDS for MySQL instance.
port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property port: The internal or public port of the ApsaraDB RDS for MySQL instance.
project typing.Union[str, ros_cdk_core.IResolvable] Property project: The name of the project.
region typing.Union[str, ros_cdk_core.IResolvable] Property region: The region where the ApsaraDB RDS for MySQL instance resides.
store_type typing.Union[str, ros_cdk_core.IResolvable] Property storeType: The storage type.
table typing.Union[str, ros_cdk_core.IResolvable] Property table: The name of the database table in the ApsaraDB RDS for MySQL instance.
username typing.Union[str, ros_cdk_core.IResolvable] Property username: The username that is used to log on to the ApsaraDB RDS for MySQL instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The id of the RDS instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

dbRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property db: The name of the database in the ApsaraDB RDS for MySQL instance.


external_store_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property externalStoreName: The name of the external store.

The name must be unique in a project and different from Logstore.


hostRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property host: The internal or public endpoint of the ApsaraDB RDS for MySQL instance.


passwordRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password that is used to log on to the ApsaraDB RDS for MySQL instance.


portRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property port: The internal or public port of the ApsaraDB RDS for MySQL instance.


projectRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property project: The name of the project.


regionRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property region: The region where the ApsaraDB RDS for MySQL instance resides.

Valid values: cn-qingdao, cn-beijing, cn-hangzhou.


store_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property storeType: The storage type.

Set the value to rds-vpc, which indicates an ApsaraDB RDS for MySQL database in a virtual private cloud (VPC).


tableRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property table: The name of the database table in the ApsaraDB RDS for MySQL instance.


usernameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property username: The username that is used to log on to the ApsaraDB RDS for MySQL instance.


vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.


instance_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The id of the RDS instance.


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.
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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_sls
ros_cdk_sls.RdsExternalStore.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
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_external_store_name ros_cdk_core.IResolvable Attribute ExternalStoreName: The name of the external store.
attr_project ros_cdk_core.IResolvable Attribute Project: The name of the project to which the external store belongs.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


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_external_store_nameRequired

attr_external_store_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExternalStoreName: The name of the external store.


attr_projectRequired

attr_project: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Project: The name of the project to which the external store belongs.