Namespace
- Implements: INamespace
This class encapsulates and extends the ROS resource type ALIYUN::CMS::Namespace.
Initializers
import com.aliyun.ros.cdk.cms.Namespace;
Namespace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.namespace(java.lang.String)
.namespace(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .specification(java.lang.String)
// .specification(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. |
namespace | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property namespace: The name of the namespace. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the namespace. |
specification | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property specification: The data retention period of the namespace. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
namespaceRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property namespace: The name of the namespace.
The name can contain lowercase letters, digits, and hyphens (-).
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the namespace.
specificationOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property specification: The data retention period of the namespace.
Valid values:
- cms.s1.large: Data storage duration is 15 days.
- cms.s1.xlarge: Data storage duration is 32 days.
- cms.s1.2xlarge: Data storage duration 63 days.
- cms.s1.3xlarge: Data storage duration 93 days.
- cms.s1.6xlarge: Data storage duration 185 days.
- cms.s1.12xlarge: Data storage duration 376 days.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cms.Namespace;
Namespace.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The timestamp that was generated when the namespace was created. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the namespace. |
attrModifyTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ModifyTime: The timestamp that was generated when the namespace was last modified. |
attrNamespace | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Namespace: The namespace for the Alibaba Cloud service. |
attrSpecification | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Specification: The data retention period of the namespace. |
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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The timestamp that was generated when the namespace was created.
Unit: milliseconds.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the namespace.
attrModifyTimeRequired
public java.lang.Object getAttrModifyTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ModifyTime: The timestamp that was generated when the namespace was last modified.
attrNamespaceRequired
public java.lang.Object getAttrNamespace();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Namespace: The namespace for the Alibaba Cloud service.
attrSpecificationRequired
public java.lang.Object getAttrSpecification();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Specification: The data retention period of the namespace.
Valid values:
- cms.s1.large: Data storage duration is 15 days.
- cms.s1.xlarge: Data storage duration is 32 days.
- cms.s1.2xlarge: Data storage duration 63 days.
- cms.s1.3xlarge: Data storage duration 93 days.
- cms.s1.6xlarge: Data storage duration 185 days.
- cms.s1.12xlarge: Data storage duration 376 days.
propsRequired
public NamespaceProps getProps();
- Type: NamespaceProps