HttpApi

• Implements: IHttpApi

This class encapsulates and extends the ROS resource type ALIYUN::APIG::HttpApi.

Initializers

import com.aliyun.ros.cdk.apig.HttpApi;
HttpApi.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .httpApiName(java.lang.String)
    .httpApiName(IResolvable)
//  .agentProtocols(IResolvable)
//  .agentProtocols(java.util.List<java.lang.String)
//  .agentProtocols(IResolvable>)
//  .aiProtocols(IResolvable)
//  .aiProtocols(java.util.List<java.lang.String)
//  .aiProtocols(IResolvable>)
//  .authConfig(IResolvable)
//  .authConfig(AuthConfigProperty)
//  .basePath(java.lang.String)
//  .basePath(IResolvable)
//  .belongGatewayId(java.lang.String)
//  .belongGatewayId(IResolvable)
//  .builtinRouteNames(IResolvable)
//  .builtinRouteNames(java.util.List<java.lang.String)
//  .builtinRouteNames(IResolvable>)
//  .deployConfigs(IResolvable)
//  .deployConfigs(java.util.List<IResolvable)
//  .deployConfigs(DeployConfigsProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableAuth(java.lang.Boolean)
//  .enableAuth(IResolvable)
//  .firstByteTimeout(java.lang.Number)
//  .firstByteTimeout(IResolvable)
//  .ingressConfig(IResolvable)
//  .ingressConfig(IngressConfigProperty)
//  .modelCategory(java.lang.String)
//  .modelCategory(IResolvable)
//  .onlyChangeConfig(java.lang.Boolean)
//  .onlyChangeConfig(IResolvable)
//  .protocols(IResolvable)
//  .protocols(java.util.List<java.lang.String)
//  .protocols(IResolvable>)
//  .removeBasePathOnForward(java.lang.Boolean)
//  .removeBasePathOnForward(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .strategy(java.lang.String)
//  .strategy(IResolvable)
//  .type(java.lang.String)
//  .type(IResolvable)
//  .versionConfig(IResolvable)
//  .versionConfig(VersionConfigProperty)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

httpApiName^Required

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

Property httpApiName: The name of the HTTP API.

agentProtocols^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property agentProtocols: The agent protocols of the HTTP API.

aiProtocols^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property aiProtocols: The AI protocols of the HTTP API.

authConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR AuthConfigProperty

Property authConfig: The authentication configuration.

basePath^Optional

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

Property basePath: The base path of the HTTP API.

belongGatewayId^Optional

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

Property belongGatewayId: The gateway ID that the HTTP API belongs to.

builtinRouteNames^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property builtinRouteNames: The builtin route names.

deployConfigs^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDeployConfigsProperty>

Property deployConfigs: The deploy configurations of the HTTP API.

description^Optional

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

Property description: The description of the HTTP API.

enableAuth^Optional

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

Property enableAuth: Whether to enable authentication.

firstByteTimeout^Optional

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

Property firstByteTimeout: The first byte timeout.

ingressConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR IngressConfigProperty

Property ingressConfig: The ingress configuration of the HTTP API.

modelCategory^Optional

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

Property modelCategory: The model category.

onlyChangeConfig^Optional

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

Property onlyChangeConfig: Whether to only change config without triggering redeployment.

True means only modify configuration without triggering redeployment.

protocols^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property protocols: The protocols supported by the HTTP API.

removeBasePathOnForward^Optional

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

Property removeBasePathOnForward: Whether to remove the base path on forward.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

strategy^Optional

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

Property strategy: The strategy of the HTTP API.

type^Optional

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

Property type: The type of the HTTP API.

versionConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR VersionConfigProperty

Property versionConfig: The version configuration of the HTTP API.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.apig.HttpApi;
HttpApi.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrHttpApiId^Required

public java.lang.Object getAttrHttpApiId();

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

Attribute HttpApiId: The ID of the HTTP API.

props^Required

public HttpApiProps getProps();

• Type: HttpApiProps