Skip to content

IApiKey

  • Extends: @alicloud/ros-cdk-core.IResource

  • Implemented By: ApiKey, IApiKey

Represents a ApiKey.

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node for this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
attrApiKeyId string | @alicloud/ros-cdk-core.IResolvable Attribute ApiKeyId: The id of the API key.
attrKey string | @alicloud/ros-cdk-core.IResolvable Attribute Key: The value of the API key.
props ApiKeyProps No description.

nodeRequired

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

The construct tree node for 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.


stackRequired

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

The stack in which this resource is defined.


attrApiKeyIdRequired

public readonly attrApiKeyId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ApiKeyId: The id of the API key.


attrKeyRequired

public readonly attrKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Key: The value of the API key.


propsRequired

public readonly props: ApiKeyProps;