Site
- Implements: ISite
This class encapsulates and extends the ROS resource type ALIYUN::ESA::SiteYou can use the , which resource type to create a site.
Initializers
import ros_cdk_esa
ros_cdk_esa.Site(
scope: Construct,
id: str,
instance_id: typing.Union[str, IResolvable],
site_name: typing.Union[str, IResolvable],
access_type: typing.Union[str, IResolvable] = None,
coverage: typing.Union[str, IResolvable] = None,
payment_type: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceId: The ID of the associated package instance. |
site_name | typing.Union[str, ros_cdk_core.IResolvable] | Property siteName: The name of the Site. |
access_type | typing.Union[str, ros_cdk_core.IResolvable] | Property accessType: The Access Type of the Site. |
coverage | typing.Union[str, ros_cdk_core.IResolvable] | Property coverage: Acceleration area. |
payment_type | typing.Union[str, ros_cdk_core.IResolvable] | Property paymentType: Payment type. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group. |
tags | typing.List[TagsProperty] | Property tags: Tags of the site. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceId: The ID of the associated package instance.
site_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property siteName: The name of the Site.
access_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accessType: The Access Type of the Site.
coverageOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property coverage: Acceleration area.
payment_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property paymentType: Payment type.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tags of the site.
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_esa
ros_cdk_esa.Site.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_access_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute AccessType: Site Access Type. |
attr_coverage | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Coverage: Acceleration area. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: Creation time. |
attr_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceId: The ID of the associated package instance. |
attr_modify_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ModifyTime: Modification time. |
attr_name_server_list | typing.Union[str, ros_cdk_core.IResolvable] | Attribute NameServerList: Site Resolution Name Server List. |
attr_resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceGroupId: The ID of the resource group. |
attr_site_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SiteId: The ID of the Site. |
attr_site_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SiteName: The name of the Site. |
attr_tags | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Tags: The tags of the Site. |
props | SiteProps | 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_access_typeRequired
attr_access_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute AccessType: Site Access Type.
attr_coverageRequired
attr_coverage: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Coverage: Acceleration area.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: Creation time.
attr_instance_idRequired
attr_instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceId: The ID of the associated package instance.
attr_modify_timeRequired
attr_modify_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ModifyTime: Modification time.
attr_name_server_listRequired
attr_name_server_list: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute NameServerList: Site Resolution Name Server List.
attr_resource_group_idRequired
attr_resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceGroupId: The ID of the resource group.
attr_site_idRequired
attr_site_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SiteId: The ID of the Site.
attr_site_nameRequired
attr_site_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SiteName: The name of the Site.
attr_tagsRequired
attr_tags: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Tags: The tags of the Site.
propsRequired
props: SiteProps
- Type: SiteProps