Namespace
- Implements: INamespace
This class encapsulates and extends the ROS resource type ALIYUN::CR::Namespace, which is used to create a namespace.
Initializers
import ros_cdk_cr
ros_cdk_cr.Namespace(
scope: Construct,
id: str,
namespace: typing.Union[str, IResolvable],
auto_create: typing.Union[bool, IResolvable] = None,
default_visibility: typing.Union[str, IResolvable] = None,
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. |
namespace | typing.Union[str, ros_cdk_core.IResolvable] | Property namespace: The name of the namespace. |
auto_create | typing.Union[bool, ros_cdk_core.IResolvable] | Property autoCreate: Specifies whether to automatically create an image repository. |
default_visibility | typing.Union[str, ros_cdk_core.IResolvable] | Property defaultVisibility: The default type of the repository that is automatically created. |
instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property instanceId: The ID of the enterprise edition instance which namespace belongs to. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
namespaceRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property namespace: The name of the namespace.
auto_createOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property autoCreate: Specifies whether to automatically create an image repository.
default_visibilityOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property defaultVisibility: The default type of the repository that is automatically created.
Valid values: PUBLIC, PRIVATE.
instance_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceId: The ID of the enterprise edition instance which namespace belongs to.
If not provided, will use personal edition instance as default.
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_cr
ros_cdk_cr.Namespace.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_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceId: The ID of the enterprise edition instance which namespace belongs to. |
attr_namespace | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Namespace: The namespace. |
attr_namespace_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute NamespaceId: The namespace ID. |
props | NamespaceProps | 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_instance_idRequired
attr_instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceId: The ID of the enterprise edition instance which namespace belongs to.
attr_namespaceRequired
attr_namespace: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Namespace: The namespace.
attr_namespace_idRequired
attr_namespace_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute NamespaceId: The namespace ID.
propsRequired
props: NamespaceProps
- Type: NamespaceProps