Skip to content

KvNamespace

This class encapsulates and extends the ROS resource type ALIYUN::ESA::KvNamespace.

Initializers

import com.aliyun.ros.cdk.esa.KvNamespace;
KvNamespace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .kvNamespace(java.lang.String)
    .kvNamespace(IResolvable)
//  .description(java.lang.String)
//  .description(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.
kvNamespace java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kvNamespace: The name of the namespace.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the namespace.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

kvNamespaceRequired

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

Property kvNamespace: The name of the namespace.


descriptionOptional

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

Property description: The description of the namespace.


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.esa.KvNamespace;
KvNamespace.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.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the namespace.
attrKvCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KvCapacity: The available capacity of the namespace.
attrKvCapacityString java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KvCapacityString: The available capacity of the namespace.
attrKvCapacityUsed java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KvCapacityUsed: The used capacity of the namespace.
attrKvCapacityUsedString java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KvCapacityUsedString: The used capacity of the namespace.
attrKvNamespace java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KvNamespace: The name of the namespace.
attrNamespaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NamespaceId: The ID of the namespace.
props KvNamespaceProps 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

attrDescriptionRequired

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

Attribute Description: The description of the namespace.


attrKvCapacityRequired

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

Attribute KvCapacity: The available capacity of the namespace.

Unit: bytes.


attrKvCapacityStringRequired

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

Attribute KvCapacityString: The available capacity of the namespace.


attrKvCapacityUsedRequired

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

Attribute KvCapacityUsed: The used capacity of the namespace.

Unit: bytes.


attrKvCapacityUsedStringRequired

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

Attribute KvCapacityUsedString: The used capacity of the namespace.


attrKvNamespaceRequired

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

Attribute KvNamespace: The name of the namespace.


attrNamespaceIdRequired

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

Attribute NamespaceId: The ID of the namespace.


propsRequired

public KvNamespaceProps getProps();