Apis

• Implements: ros_cdk_apigateway.datasource.IApis

This class encapsulates and extends the ROS resource type DATASOURCE::ApiGateway::Apis, which is used to query APIs in API Gateway.

Initializers

from ros_cdk_apigateway import datasource
datasource.Apis(
  scope: Construct,
  id: str,
  api_id: typing.Union[str, IResolvable] = None,
  api_name: typing.Union[str, IResolvable] = None,
  catalog_id: typing.Union[str, IResolvable] = None,
  enable_tag_auth: typing.Union[bool, IResolvable] = None,
  group_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  visibility: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

api_id^Optional

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

Property apiId: ID of the specified API.

api_name^Optional

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

Property apiName: API name (fuzzy matching).

catalog_id^Optional

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

Property catalogId: Catalog number.

enable_tag_auth^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableTagAuth: Enable label validation.

group_id^Optional

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

Property groupId: ID of the specified group.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

visibility^Optional

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

Property visibility: Whether the API is public.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

from ros_cdk_apigateway import datasource
datasource.Apis.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_api_ids^Required

attr_api_ids: typing.Union[str, IResolvable]

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

Attribute ApiIds: The list of The ApiGateway api ids.

attr_apis^Required

attr_apis: typing.Union[str, IResolvable]

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

Attribute Apis: The information about ApiGateway apis.

props^Required

props: ApisProps

• Type: ApisProps