Secret
- Implements: @alicloud/ros-cdk-kms.datasource.ISecret
This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Secret, which is used to query the information about a 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
- Type: SecretProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret. |
attrAutomaticRotation | string | @alicloud/ros-cdk-core.IResolvable | Attribute AutomaticRotation: Indicates whether automatic rotation is enabled. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the secret was created. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description of the secret. |
attrDkmsInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DKMSInstanceId: The ID of the dedicated KMS instance. |
attrEncryptionKeyId | string | @alicloud/ros-cdk-core.IResolvable | Attribute EncryptionKeyId: The ID of the customer master key (CMK) that is used to encrypt the secret value. |
attrExtendedConfig | string | @alicloud/ros-cdk-core.IResolvable | Attribute ExtendedConfig: The extended configuration of the secret. |
attrLastRotationDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute LastRotationDate: The time when the last rotation was performed. |
attrNextRotationDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute NextRotationDate: The time when the next rotation will be performed. |
attrPlannedDeleteTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted. |
attrRotationInterval | string | @alicloud/ros-cdk-core.IResolvable | Attribute RotationInterval: The interval for automatic rotation. |
attrSecretName | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecretName: The name of the secret. |
attrSecretType | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecretType: The type of the secret. |
attrUpdateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute UpdateTime: The time when the secret was updated. |
props | SecretProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Arn: The Alibaba Cloud Resource Name (ARN) of the secret.
attrAutomaticRotationRequired
public readonly attrAutomaticRotation: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AutomaticRotation: Indicates whether automatic rotation is enabled.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time when the secret was created.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description of the secret.
attrDkmsInstanceIdRequired
public readonly attrDkmsInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DKMSInstanceId: The ID of the dedicated KMS instance.
attrEncryptionKeyIdRequired
public readonly attrEncryptionKeyId: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ExtendedConfig: The extended configuration of the secret.
attrLastRotationDateRequired
public readonly attrLastRotationDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LastRotationDate: The time when the last rotation was performed.
attrNextRotationDateRequired
public readonly attrNextRotationDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NextRotationDate: The time when the next rotation will be performed.
attrPlannedDeleteTimeRequired
public readonly attrPlannedDeleteTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PlannedDeleteTime: The time when the secret is scheduled to be deleted.
attrRotationIntervalRequired
public readonly attrRotationInterval: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SecretName: The name of the secret.
attrSecretTypeRequired
public readonly attrSecretType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SecretType: The type of the secret.
attrUpdateTimeRequired
public readonly attrUpdateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UpdateTime: The time when the secret was updated.
propsRequired
public readonly props: SecretProps;
- Type: SecretProps