Skip to content

Namespace

  • Implements: com.aliyun.ros.cdk.sae.datasource.INamespace

This class encapsulates and extends the ROS resource type DATASOURCE::SAE::Namespace.

Initializers

import com.aliyun.ros.cdk.sae.datasource.Namespace;
Namespace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .namespaceId(java.lang.String)
//  .namespaceId(IResolvable)
//  .nameSpaceShortId(java.lang.String)
//  .nameSpaceShortId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
namespaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property namespaceId: The ID of the namespace.
nameSpaceShortId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nameSpaceShortId: The ID of the short namespace.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

namespaceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespaceId: The ID of the namespace.


nameSpaceShortIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property nameSpaceShortId: The ID of the short namespace.


refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.sae.datasource.Namespace;
Namespace.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAppCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AppCount: The number of applications.
attrBelongRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BelongRegion: The region to which the namespace belongs.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the namespace.
attrJumpServerAppId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute JumpServerAppId: The ID of the jump server application.
attrJumpServerIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute JumpServerIp: The IP address of the jump server.
attrLastChangeOrderId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LastChangeOrderId: The ID of the change order.
attrLastChangeOrderRunning java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LastChangeOrderRunning: Indicates whether a change order is being executed in the namespace.
attrLastChangeOrderStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LastChangeOrderStatus: The status of the latest change order.
attrNamespaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NamespaceId: The ID of the namespace.
attrNamespaceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NamespaceName: The name of the namespace.
attrNameSpaceShortId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NameSpaceShortId: The ID of the short namespace.
attrNotificationExpired java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NotificationExpired: Indicates whether the notification of a change order is expired.
attrSecurityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroupId: The ID of the security group.
attrTenantId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TenantId: The ID of the tenant in the SAE namespace.
attrUserId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UserId: The ID of the user.
attrVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC).
attrVpcName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpcName: The name of the VPC.
attrVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: The ID of the vSwitch.
attrVSwitchName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchName: The name of the vSwitch.
props NamespaceProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAppCountRequired

public java.lang.Object getAttrAppCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AppCount: The number of applications.


attrBelongRegionRequired

public java.lang.Object getAttrBelongRegion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BelongRegion: The region to which the namespace belongs.


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the namespace.


attrJumpServerAppIdRequired

public java.lang.Object getAttrJumpServerAppId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute JumpServerAppId: The ID of the jump server application.


attrJumpServerIpRequired

public java.lang.Object getAttrJumpServerIp();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute JumpServerIp: The IP address of the jump server.


attrLastChangeOrderIdRequired

public java.lang.Object getAttrLastChangeOrderId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LastChangeOrderId: The ID of the change order.


attrLastChangeOrderRunningRequired

public java.lang.Object getAttrLastChangeOrderRunning();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LastChangeOrderRunning: Indicates whether a change order is being executed in the namespace.


attrLastChangeOrderStatusRequired

public java.lang.Object getAttrLastChangeOrderStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LastChangeOrderStatus: The status of the latest change order.


attrNamespaceIdRequired

public java.lang.Object getAttrNamespaceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NamespaceId: The ID of the namespace.


attrNamespaceNameRequired

public java.lang.Object getAttrNamespaceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NamespaceName: The name of the namespace.


attrNameSpaceShortIdRequired

public java.lang.Object getAttrNameSpaceShortId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NameSpaceShortId: The ID of the short namespace.


attrNotificationExpiredRequired

public java.lang.Object getAttrNotificationExpired();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NotificationExpired: Indicates whether the notification of a change order is expired.


attrSecurityGroupIdRequired

public java.lang.Object getAttrSecurityGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroupId: The ID of the security group.


attrTenantIdRequired

public java.lang.Object getAttrTenantId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TenantId: The ID of the tenant in the SAE namespace.


attrUserIdRequired

public java.lang.Object getAttrUserId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute UserId: The ID of the user.


attrVpcIdRequired

public java.lang.Object getAttrVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The ID of the virtual private cloud (VPC).


attrVpcNameRequired

public java.lang.Object getAttrVpcName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcName: The name of the VPC.


attrVSwitchIdRequired

public java.lang.Object getAttrVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of the vSwitch.


attrVSwitchNameRequired

public java.lang.Object getAttrVSwitchName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchName: The name of the vSwitch.


propsRequired

public NamespaceProps getProps();