Skip to content

SecretParameter

  • Implements: com.aliyun.ros.cdk.oos.datasource.ISecretParameter

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::SecretParameter.

Initializers

import com.aliyun.ros.cdk.oos.datasource.SecretParameter;
SecretParameter.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .secretParameterName(java.lang.String)
    .secretParameterName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
secretParameterName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secretParameterName: The name of the parameter.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

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 parameter.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.oos.datasource.SecretParameter;
SecretParameter.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.
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 ID of the key of Key Management Service (KMS) that is used for encryption.
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 the 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 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: The tags of the parameter.
attrType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Type: The type of the 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.
attrValue java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Value: The value of the encryption parameter.
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 ID of the key of Key Management Service (KMS) that is used for encryption.


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 the 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 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: The tags of the parameter.


attrTypeRequired

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

Attribute Type: The type of the 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.


attrValueRequired

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

Attribute Value: The value of the encryption parameter.


propsRequired

public SecretParameterProps getProps();