Skip to content

Secret

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

Initializers

import { datasource } from '@alicloud/ros-cdk-kms'
new datasource.Secret(scope: Construct, id: string, props: SecretProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props SecretProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { datasource } from '@alicloud/ros-cdk-kms'
datasource.Secret.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrArn @alicloud/ros-cdk-core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.
attrAutomaticRotation @alicloud/ros-cdk-core.IResolvable Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the secret was created.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the secret.
attrDkmsInstanceId @alicloud/ros-cdk-core.IResolvable Attribute DKMSInstanceId: The ID of the dedicated KMS instance.
attrEncryptionKeyId @alicloud/ros-cdk-core.IResolvable Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value.
attrExtendedConfig @alicloud/ros-cdk-core.IResolvable Attribute ExtendedConfig: The extended configuration of the secret.
attrLastRotationDate @alicloud/ros-cdk-core.IResolvable Attribute LastRotationDate: The time when the last rotation was performed.
attrNextRotationDate @alicloud/ros-cdk-core.IResolvable Attribute NextRotationDate: The time when the next rotation will be performed.
attrPlannedDeleteTime @alicloud/ros-cdk-core.IResolvable Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.
attrRotationInterval @alicloud/ros-cdk-core.IResolvable Attribute RotationInterval: The interval for automatic rotation.
attrSecretName @alicloud/ros-cdk-core.IResolvable Attribute SecretName: The name of the secret.
attrSecretType @alicloud/ros-cdk-core.IResolvable Attribute SecretType: The type of the secret.
attrUpdateTime @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: The time when the secret was updated.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrArnRequired

public readonly attrArn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrAutomaticRotationRequired

public readonly attrAutomaticRotation: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.


attrCreateTimeRequired

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the secret was created.


attrDescriptionRequired

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the secret.


attrDkmsInstanceIdRequired

public readonly attrDkmsInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DKMSInstanceId: The ID of the dedicated KMS instance.


attrEncryptionKeyIdRequired

public readonly attrEncryptionKeyId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrExtendedConfigRequired

public readonly attrExtendedConfig: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExtendedConfig: The extended configuration of the secret.


attrLastRotationDateRequired

public readonly attrLastRotationDate: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrNextRotationDateRequired

public readonly attrNextRotationDate: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrPlannedDeleteTimeRequired

public readonly attrPlannedDeleteTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrRotationIntervalRequired

public readonly attrRotationInterval: IResolvable;
  • Type: @alicloud/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 readonly attrSecretName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecretName: The name of the secret.


attrSecretTypeRequired

public readonly attrSecretType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecretType: The type of the secret.


attrUpdateTimeRequired

public readonly attrUpdateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UpdateTime: The time when the secret was updated.