ApiAttachment

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

Initializers

import com.aliyun.ros.cdk.apig.ApiAttachment;
ApiAttachment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .backendScene(java.lang.String)
    .backendScene(IResolvable)
    .environmentId(java.lang.String)
    .environmentId(IResolvable)
    .httpApiId(java.lang.String)
    .httpApiId(IResolvable)
    .serviceConfigs(IResolvable)
    .serviceConfigs(java.util.List<IResolvable)
    .serviceConfigs(ServiceConfigsProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .domainIds(IResolvable)
//  .domainIds(java.util.List<java.lang.String)
//  .domainIds(IResolvable>)
//  .routeId(java.lang.String)
//  .routeId(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.
backendScene	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property backendScene: API release scenario.
environmentId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property environmentId: The ID of the environment to which the API is to deploy.
httpApiId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property httpApiId: The ID of the HTTP API.
serviceConfigs	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceConfigsProperty>	Property serviceConfigs: Services associated with API publishing and their configurations.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of publication.
domainIds	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property domainIds: The list of user domain names associated with API publishing.
routeId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property routeId: The route ID.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

backendScene^Required

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

Property backendScene: API release scenario.

---

environmentId^Required

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

Property environmentId: The ID of the environment to which the API is to deploy.

---

httpApiId^Required

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

Property httpApiId: The ID of the HTTP API.

---

serviceConfigs^Required

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

Property serviceConfigs: Services associated with API publishing and their configurations.

---

description^Optional

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

Property description: The description of publication.

---

domainIds^Optional

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

Property domainIds: The list of user domain names associated with API publishing.

---

routeId^Optional

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

Property routeId: The route ID.

When publishing an HTTP API route, it must be passed in.

---

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.

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

---

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

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• 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.
attrEnvironmentId	com.aliyun.ros.cdk.core.IResolvable	Attribute EnvironmentId: The ID of the environment to which the API is to deploy.
attrHttpApiId	com.aliyun.ros.cdk.core.IResolvable	Attribute HttpApiId: The ID of the HTTP API.
attrRouteId	com.aliyun.ros.cdk.core.IResolvable	Attribute RouteId: The route ID.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrEnvironmentId^Required

public IResolvable getAttrEnvironmentId();

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

Attribute EnvironmentId: The ID of the environment to which the API is to deploy.

---

attrHttpApiId^Required

public IResolvable getAttrHttpApiId();

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

Attribute HttpApiId: The ID of the HTTP API.

---

attrRouteId^Required

public IResolvable getAttrRouteId();

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

Attribute RouteId: The route ID.

When publishing an HTTP API route, it must be passed in.

---