App
This class encapsulates and extends the ROS resource type ALIYUN::ElasticSearchServerless::App
, which is used to create an Elasticsearch serverless application.
Initializers
import ros_cdk_elasticsearchserverless
ros_cdk_elasticsearchserverless.App(
scope: Construct,
id: str,
app_name: typing.Union[str, IResolvable],
authentication: typing.Union[IResolvable, AuthenticationProperty],
quota_info: typing.Union[IResolvable, QuotaInfoProperty],
app_version: typing.Union[str, IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
network: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NetworkProperty]]] = None,
private_network: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PrivateNetworkProperty]]] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
app_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property appName: The name of the elastic search serverless version app. |
authentication |
typing.Union[ros_cdk_core.IResolvable, AuthenticationProperty] |
Property authentication: The authentication of the app. |
quota_info |
typing.Union[ros_cdk_core.IResolvable, QuotaInfoProperty] |
Property quotaInfo: The quota info of the app. |
app_version |
typing.Union[str, ros_cdk_core.IResolvable] |
Property appVersion: The version of the app. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of the app. |
network |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkProperty]]] |
Property network: The public network of the app. |
private_network |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PrivateNetworkProperty]]] |
Property privateNetwork: The private network of the app. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
app_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property appName: The name of the elastic search serverless version app.
authentication
Required
- Type: typing.Union[ros_cdk_core.IResolvable, AuthenticationProperty]
Property authentication: The authentication of the app.
Currently only supports specifying passwords for initial users
quota_info
Required
- Type: typing.Union[ros_cdk_core.IResolvable, QuotaInfoProperty]
Property quotaInfo: The quota info of the app.
app_version
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property appVersion: The version of the app.
description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the app.
network
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NetworkProperty]]]
Property network: The public network of the app.
private_network
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PrivateNetworkProperty]]]
Property privateNetwork: The private network of the app.
enable_resource_property_constraint
Optional
- 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.
- 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
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_elasticsearchserverless
ros_cdk_elasticsearchserverless.App.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. |
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_instance_id |
ros_cdk_core.IResolvable |
Attribute InstanceId: The Id of the ElasticSearch serverless instance. |
attr_private_es_domain |
ros_cdk_core.IResolvable |
Attribute PrivateESDomain: The private network domain of the app. |
attr_private_kibana_domain |
ros_cdk_core.IResolvable |
Attribute PrivateKibanaDomain: The private network kibana domain of the app. |
attr_public_es_domain |
ros_cdk_core.IResolvable |
Attribute PublicESDomain: The public network domain of the app. |
attr_public_kibana_domain |
ros_cdk_core.IResolvable |
Attribute PublicKibanaDomain: The public network kibana domain of the app. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
ref
Required
ref: str
- Type: str
stack
Required
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resource
Optional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_instance_id
Required
attr_instance_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute InstanceId: The Id of the ElasticSearch serverless instance.
attr_private_es_domain
Required
attr_private_es_domain: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PrivateESDomain: The private network domain of the app.
attr_private_kibana_domain
Required
attr_private_kibana_domain: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PrivateKibanaDomain: The private network kibana domain of the app.
attr_public_es_domain
Required
attr_public_es_domain: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicESDomain: The public network domain of the app.
attr_public_kibana_domain
Required
attr_public_kibana_domain: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicKibanaDomain: The public network kibana domain of the app.