Skip to content

ConsumerProps

Properties for defining a Consumer.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-consumer

Initializer

import { ConsumerProps } from '@alicloud/ros-cdk-apig'
const consumerProps: ConsumerProps = { ... }

Properties

Name Type Description
akSkIdentityConfigs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AkSkIdentityConfigsProperty[] Property akSkIdentityConfigs: List of AK\/SK identity configurations.
apikeyIdentityConfig @alicloud/ros-cdk-core.IResolvable | ApikeyIdentityConfigProperty Property apikeyIdentityConfig: API key identity configuration.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the consumer.
enable boolean | @alicloud/ros-cdk-core.IResolvable Property enable: Whether to enable the consumer.
gatewayType string | @alicloud/ros-cdk-core.IResolvable Property gatewayType: The type of the gateway.
jwtIdentityConfig @alicloud/ros-cdk-core.IResolvable | JwtIdentityConfigProperty Property jwtIdentityConfig: JWT identity configuration.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the consumer.

akSkIdentityConfigsOptional

public readonly akSkIdentityConfigs: IResolvable | IResolvable | AkSkIdentityConfigsProperty[];

Property akSkIdentityConfigs: List of AK\/SK identity configurations.


apikeyIdentityConfigOptional

public readonly apikeyIdentityConfig: IResolvable | ApikeyIdentityConfigProperty;

Property apikeyIdentityConfig: API key identity configuration.


descriptionOptional

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

Property description: The description of the consumer.


enableOptional

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

Property enable: Whether to enable the consumer.


gatewayTypeOptional

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

Property gatewayType: The type of the gateway.


jwtIdentityConfigOptional

public readonly jwtIdentityConfig: IResolvable | JwtIdentityConfigProperty;

Property jwtIdentityConfig: JWT identity configuration.


nameOptional

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

Property name: The name of the consumer.