Skip to content

ApiAttachmentProps

Properties for defining a ApiAttachment.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-apiattachment

Initializer

import com.aliyun.ros.cdk.apig.ApiAttachmentProps;
ApiAttachmentProps.builder()
    .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();

Properties

Name Type 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.

backendSceneRequired

public java.lang.Object getBackendScene();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backendScene: API release scenario.


environmentIdRequired

public java.lang.Object getEnvironmentId();
  • 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.


httpApiIdRequired

public java.lang.Object getHttpApiId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpApiId: The ID of the HTTP API.


serviceConfigsRequired

public java.lang.Object getServiceConfigs();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceConfigsProperty>

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


descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of publication.


domainIdsOptional

public java.lang.Object getDomainIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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


routeIdOptional

public java.lang.Object getRouteId();
  • 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.