Kv

• Implements: IKv

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

Initializers

import com.aliyun.ros.cdk.esa.Kv;
Kv.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .key(java.lang.String)
    .key(IResolvable)
    .namespace(java.lang.String)
    .namespace(IResolvable)
    .value(java.lang.String)
    .value(IResolvable)
//  .expiration(java.lang.Number)
//  .expiration(IResolvable)
//  .expirationTtl(java.lang.Number)
//  .expirationTtl(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

key^Required

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

Property key: The key name.

The name can be up to 512 characters in length and cannot contain spaces or backslashes ().

namespace^Required

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

Property namespace: The name specified when calling [CreatevNamespace] https:\/\/help.aliyun.com\/document_detail\/2850317.html.

value^Required

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

Property value: The content of the key.

If the content has more than 256 characters in length, the system displays the first 100 and the last 100 characters, and omits the middle part.

expiration^Optional

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

Property expiration: The content of the key, which can be up to 2 MB (2 × 1000 × 1000).

If the content is larger than 2 MB, call [PutKvWithHighCapacity] https://www.alibabacloud.com/help/en/doc-detail/2850486.html.

expirationTtl^Optional

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

Property expirationTtl: The time when the key-value pair expires, which cannot be earlier than the current time.

The value is a timestamp in seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.Kv;
Kv.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrValue^Required

public java.lang.Object getAttrValue();

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

Attribute Value: The content of the key.

If the content has more than 256 characters in length, the system displays the first 100 and the last 100 characters, and omits the middle part.

props^Required

public KvProps getProps();

• Type: KvProps