Service
This class encapsulates and extends the ROS resource type ALIYUN::APIG::Service.
Initializers
import com.aliyun.ros.cdk.apig.Service;
Service.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.addresses(IResolvable)
.addresses(java.util.List<java.lang.String)
.addresses(IResolvable>)
.gatewayId(java.lang.String)
.gatewayId(IResolvable)
.serviceName(java.lang.String)
.serviceName(IResolvable)
.sourceType(java.lang.String)
.sourceType(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. |
addresses |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
Property addresses: Service Address List. |
gatewayId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property gatewayId: The ID of the Cloud Native API Gateway. |
serviceName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property serviceName: The name of the service. |
sourceType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property sourceType: The type of the service source. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
addressesRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property addresses: Service Address List.
gatewayIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property gatewayId: The ID of the Cloud Native API Gateway.
serviceNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property serviceName: The name of the service.
sourceTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property sourceType: The type of the service source.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.apig.Service;
Service.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrAddresses |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Addresses: Service Address List. |
attrGatewayId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute GatewayId: The ID of the Cloud Native API Gateway. |
attrServiceId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ServiceId: The ID of the service. |
attrServiceName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ServiceName: The Name of the service . |
attrSourceType |
com.aliyun.ros.cdk.core.IResolvable |
Attribute SourceType: Service source type. |
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
attrAddressesRequired
public IResolvable getAttrAddresses();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Addresses: Service Address List.
attrGatewayIdRequired
public IResolvable getAttrGatewayId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute GatewayId: The ID of the Cloud Native API Gateway.
attrServiceIdRequired
public IResolvable getAttrServiceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceId: The ID of the service.
attrServiceNameRequired
public IResolvable getAttrServiceName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceName: The Name of the service .
attrSourceTypeRequired
public IResolvable getAttrSourceType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute SourceType: Service source type.