Skip to content

IEnvironment

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_apig.datasource.Environment, ros_cdk_apig.datasource.IEnvironment

Represents a Environment.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The description of the Environment.
attr_environment_id typing.Union[str, ros_cdk_core.IResolvable] Attribute EnvironmentId: The ID of the Environment.
attr_environment_name typing.Union[str, ros_cdk_core.IResolvable] Attribute EnvironmentName: The name of the Environment.
attr_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Attribute GatewayId: Cloud-native API Gateway ID.
attr_resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceGroupId: The ID of the resource group.
props EnvironmentProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: 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

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_descriptionRequired

attr_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Description: The description of the Environment.


attr_environment_idRequired

attr_environment_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EnvironmentId: The ID of the Environment.


attr_environment_nameRequired

attr_environment_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EnvironmentName: The name of the Environment.


attr_gateway_idRequired

attr_gateway_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute GatewayId: Cloud-native API Gateway ID.


attr_resource_group_idRequired

attr_resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ResourceGroupId: The ID of the resource group.


propsRequired

props: EnvironmentProps