Skip to content

Apis

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

Initializers 

import com.aliyun.ros.cdk.apigateway.datasource.Apis;
Apis.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .apiId(java.lang.String)
//  .apiId(IResolvable)
//  .apiName(java.lang.String)
//  .apiName(IResolvable)
//  .catalogId(java.lang.String)
//  .catalogId(IResolvable)
//  .enableTagAuth(java.lang.Boolean)
//  .enableTagAuth(IResolvable)
//  .groupId(java.lang.String)
//  .groupId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .visibility(java.lang.String)
//  .visibility(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
apiId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property apiId: ID of the specified API.
apiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property apiName: API name (fuzzy matching).
catalogId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property catalogId: Catalog number.
enableTagAuth java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableTagAuth: Enable label validation.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupId: ID of the specified group.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
visibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property visibility: Whether the API is public.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

apiIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiId: ID of the specified API.

apiNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiName: API name (fuzzy matching).

catalogIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property catalogId: Catalog number.

enableTagAuthOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableTagAuth: Enable label validation.

groupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupId: ID of the specified group.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.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.

visibilityOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property visibility: Whether the API is public.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.apigateway.datasource.Apis;
Apis.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrApiIds com.aliyun.ros.cdk.core.IResolvable Attribute ApiIds: The list of The ApiGateway api ids.
attrApis com.aliyun.ros.cdk.core.IResolvable Attribute Apis: The information about ApiGateway apis.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrApiIdsRequired 

public IResolvable getAttrApiIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ApiIds: The list of The ApiGateway api ids.

attrApisRequired 

public IResolvable getAttrApis();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Apis: The information about ApiGateway apis.