Configuration
- Implements: IConfiguration
This class encapsulates and extends the ROS resource type ALIYUN::ACM::Configuration.
Initializers
import com.aliyun.ros.cdk.acm.Configuration;
Configuration.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.content(java.lang.String)
.content(IResolvable)
.dataId(java.lang.String)
.dataId(IResolvable)
.namespaceId(java.lang.String)
.namespaceId(IResolvable)
// .appName(java.lang.String)
// .appName(IResolvable)
// .desc(java.lang.String)
// .desc(IResolvable)
// .group(java.lang.String)
// .group(IResolvable)
// .tags(java.lang.String)
// .type(java.lang.String)
// .type(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. |
content | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property content: The contents of the configuration. |
dataId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dataId: The ID of the configuration. |
namespaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property namespaceId: ID of namespace. |
appName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property appName: Configuration application name. |
desc | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property desc: Configuration description explains. |
group | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property group: Group. |
tags | java.lang.String | Property tags: Label configurations, such as the presence of a plurality of tags, separated by commas. |
type | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property type: Provisioning content format, optional values as follows: text, json, xml, yaml, text\/html, properties. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
contentRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property content: The contents of the configuration.
dataIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dataId: The ID of the configuration.
Allowed characters are upper and lower case letters, numbers, decimal points (.), Colons (:), asterisks (*), underscores (_), and underscores (-). When the ID prefix is the following value, ACM will automatically use KMS service to encrypt this configuration: The prefix is cipher-: the KMS service is called to encrypt and decrypt the configuration. The size of the encrypted data does not exceed 4 KB, and the maximum does not exceed 6 KB. Special symbols such as and (&) will decrypt errors and are not recommended. The prefix is cipher-kms-aes-128-: using KMS's envelope encryption and decryption method, the configuration content can exceed 6 KB, up to 100 KB. The plain text data of the configuration content will not be transmitted to the KMS system, which is more secure and recommended.
namespaceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property namespaceId: ID of namespace.
appNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property appName: Configuration application name.
descOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property desc: Configuration description explains.
groupOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property group: Group.
tagsOptional
- Type: java.lang.String
Property tags: Label configurations, such as the presence of a plurality of tags, separated by commas.
typeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property type: Provisioning content format, optional values as follows: text, json, xml, yaml, text\/html, properties.
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.acm.Configuration;
Configuration.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. |
attrDataId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DataId: The ID of the configuration. |
attrGroup | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Group: Group. |
attrNamespaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NamespaceId: ID of namespace. |
props | ConfigurationProps | 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
attrDataIdRequired
public java.lang.Object getAttrDataId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DataId: The ID of the configuration.
attrGroupRequired
public java.lang.Object getAttrGroup();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Group: Group.
attrNamespaceIdRequired
public java.lang.Object getAttrNamespaceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NamespaceId: ID of namespace.
propsRequired
public ConfigurationProps getProps();
- Type: ConfigurationProps