Apis

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
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
api_id	typing.Union[str, ros_cdk_core.IResolvable]	Property apiId: ID of the specified API.
api_name	typing.Union[str, ros_cdk_core.IResolvable]	Property apiName: API name (fuzzy matching).
catalog_id	typing.Union[str, ros_cdk_core.IResolvable]	Property catalogId: Catalog number.
enable_tag_auth	typing.Union[bool, ros_cdk_core.IResolvable]	Property enableTagAuth: Enable label validation.
group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property groupId: ID of the specified group.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
visibility	typing.Union[str, ros_cdk_core.IResolvable]	Property visibility: Whether the API is public.
enable_resource_property_constraint	bool	No description.

---

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

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

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

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_api_ids	ros_cdk_core.IResolvable	Attribute ApiIds: The list of The ApiGateway api ids.
attr_apis	ros_cdk_core.IResolvable	Attribute Apis: The information about ApiGateway apis.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ApiIds: The list of The ApiGateway api ids.

---

attr_apis^Required

attr_apis: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Apis: The information about ApiGateway apis.

---