Skip to content

Secret

This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Secret.

Initializers 

import com.aliyun.ros.cdk.kms.datasource.Secret;
Secret.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .secretName(java.lang.String)
    .secretName(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.
secretName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secretName: The name of the secret.
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

secretNameRequired

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

Property secretName: The name of the secret.

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

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.kms.datasource.Secret;
Secret.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.
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.
attrArn com.aliyun.ros.cdk.core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.
attrAutomaticRotation com.aliyun.ros.cdk.core.IResolvable Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the secret was created.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the secret.
attrDkmsInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DKMSInstanceId: The ID of the dedicated KMS instance.
attrEncryptionKeyId com.aliyun.ros.cdk.core.IResolvable Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value.
attrExtendedConfig com.aliyun.ros.cdk.core.IResolvable Attribute ExtendedConfig: The extended configuration of the secret.
attrLastRotationDate com.aliyun.ros.cdk.core.IResolvable Attribute LastRotationDate: The time when the last rotation was performed.
attrNextRotationDate com.aliyun.ros.cdk.core.IResolvable Attribute NextRotationDate: The time when the next rotation will be performed.
attrPlannedDeleteTime com.aliyun.ros.cdk.core.IResolvable Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.
attrRotationInterval com.aliyun.ros.cdk.core.IResolvable Attribute RotationInterval: The interval for automatic rotation.
attrSecretName com.aliyun.ros.cdk.core.IResolvable Attribute SecretName: The name of the secret.
attrSecretType com.aliyun.ros.cdk.core.IResolvable Attribute SecretType: The type of the secret.
attrUpdateTime com.aliyun.ros.cdk.core.IResolvable Attribute UpdateTime: The time when the secret was updated.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrArnRequired 

public IResolvable getAttrArn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.

attrAutomaticRotationRequired 

public IResolvable getAttrAutomaticRotation();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the secret was created.

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the secret.

attrDkmsInstanceIdRequired 

public IResolvable getAttrDkmsInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DKMSInstanceId: The ID of the dedicated KMS instance.

attrEncryptionKeyIdRequired 

public IResolvable getAttrEncryptionKeyId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value.

attrExtendedConfigRequired 

public IResolvable getAttrExtendedConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExtendedConfig: The extended configuration of the secret.

attrLastRotationDateRequired 

public IResolvable getAttrLastRotationDate();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LastRotationDate: The time when the last rotation was performed.

attrNextRotationDateRequired 

public IResolvable getAttrNextRotationDate();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute NextRotationDate: The time when the next rotation will be performed.

attrPlannedDeleteTimeRequired 

public IResolvable getAttrPlannedDeleteTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.

attrRotationIntervalRequired 

public IResolvable getAttrRotationInterval();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RotationInterval: The interval for automatic rotation.

The value is in the integer[unit] format. integer indicates the length of time. unit: indicates the time unit. The value of unit is fixed as s. For example, if the value is 604800s, automatic rotation is performed at a 7-day interval.The value is in the integer[unit] format. integer indicates the length of time. unit: indicates the time unit. The value of unit is fixed as s. For example, if the value is 604800s, automatic rotation is performed at a 7-day interval.

attrSecretNameRequired 

public IResolvable getAttrSecretName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SecretName: The name of the secret.

attrSecretTypeRequired 

public IResolvable getAttrSecretType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SecretType: The type of the secret.

attrUpdateTimeRequired 

public IResolvable getAttrUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UpdateTime: The time when the secret was updated.