SecretParameter
- Implements: ISecretParameter
This class encapsulates and extends the ROS resource type ALIYUN::OOS::SecretParameter.
Initializers
import com.aliyun.ros.cdk.oos.SecretParameter;
SecretParameter.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.secretParameterName(java.lang.String)
.secretParameterName(IResolvable)
.value(java.lang.String)
.value(IResolvable)
// .constraints(IResolvable)
// .constraints(java.util.Map<java.lang.String, java.lang.Object>)
// .description(java.lang.String)
// .description(IResolvable)
// .keyId(java.lang.String)
// .keyId(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .tags(java.util.List<TagsProperty>)
.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. |
secretParameterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property secretParameterName: The name of the encryption parameter. |
value | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property value: The value of the encryption parameter. |
constraints | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property constraints: The constraints of the encryption parameter. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the encryption parameter. |
keyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property keyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of resource group. |
tags | java.util.List<TagsProperty> | Property tags: Tags of encryption parameter. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
secretParameterNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property secretParameterName: The name of the encryption parameter.
The name must be 1 to 180 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ALIBABA, ALICLOUD, ACS or OOS.
valueRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property value: The value of the encryption parameter.
The value must be 1 to 4096 characters in length.
constraintsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property constraints: The constraints of the encryption parameter.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the encryption parameter.
The description must be 1 to 200 characters in length.
keyIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property keyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of resource group.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of encryption parameter.
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.oos.SecretParameter;
SecretParameter.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. |
attrConstraints | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Constraints: The constraints of the encryption parameter. |
attrCreatedBy | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreatedBy: The user who created the encryption parameter. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the encryption parameter was created. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the encryption parameter. |
attrKeyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute KeyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter. |
attrParameterVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ParameterVersion: The version number of the encryption parameter. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of resource group. |
attrSecretParameterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecretParameterId: The ID of the encryption parameter. |
attrSecretParameterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecretParameterName: The name of the encryption parameter. |
attrShareType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ShareType: The share type of the encryption parameter. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: Tags of encryption parameter. |
attrType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Type: The data type of the encryption parameter. |
attrUpdatedBy | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UpdatedBy: The user who updated the encryption parameter. |
attrUpdatedDate | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UpdatedDate: The time when the encryption parameter was updated. |
props | SecretParameterProps | 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
attrConstraintsRequired
public java.lang.Object getAttrConstraints();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Constraints: The constraints of the encryption parameter.
attrCreatedByRequired
public java.lang.Object getAttrCreatedBy();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreatedBy: The user who created the encryption parameter.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the encryption parameter was created.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the encryption parameter.
attrKeyIdRequired
public java.lang.Object getAttrKeyId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute KeyId: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
attrParameterVersionRequired
public java.lang.Object getAttrParameterVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ParameterVersion: The version number of the encryption parameter.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of resource group.
attrSecretParameterIdRequired
public java.lang.Object getAttrSecretParameterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecretParameterId: The ID of the encryption parameter.
attrSecretParameterNameRequired
public java.lang.Object getAttrSecretParameterName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecretParameterName: The name of the encryption parameter.
attrShareTypeRequired
public java.lang.Object getAttrShareType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ShareType: The share type of the encryption parameter.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: Tags of encryption parameter.
attrTypeRequired
public java.lang.Object getAttrType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Type: The data type of the encryption parameter.
attrUpdatedByRequired
public java.lang.Object getAttrUpdatedBy();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UpdatedBy: The user who updated the encryption parameter.
attrUpdatedDateRequired
public java.lang.Object getAttrUpdatedDate();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UpdatedDate: The time when the encryption parameter was updated.
propsRequired
public SecretParameterProps getProps();
- Type: SecretParameterProps